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
use crate::{
    Bus, Error, Interface, Member, Message, MessageFlags, MessageHeaderError, MessageHeaderField,
    MessageType, ObjectPath, Value,
};
use std::collections::BTreeSet;
use std::convert::TryInto;

macro_rules! get_header {
    ($self:ident, $enum_case:ident) => {
        for h in &$self.fields {
            if let MessageHeaderField::$enum_case(value) = h {
                return Some(value);
            }
        }

        return None;
    };
}

/// This represents a DBus [message header].
///
/// [message header]: https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol
#[derive(Debug, Clone, PartialOrd, PartialEq, Ord, Eq)]
pub struct MessageHeader {
    pub(crate) is_le: bool,
    pub(crate) message_type: MessageType,
    pub(crate) message_flags: MessageFlags,
    pub(crate) version: u8,
    pub(crate) serial: u32,
    pub(crate) fields: BTreeSet<MessageHeaderField>,
}

impl MessageHeader {
    /// Create a `MessageHeader` object. It can fail if the required [header fields] are not
    /// present.
    ///
    /// [header fields]: https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-header-fields
    pub fn new(
        is_le: bool,
        message_type: MessageType,
        message_flags: MessageFlags,
        version: u8,
        serial: u32,
        fields: BTreeSet<MessageHeaderField>,
    ) -> Result<MessageHeader, MessageHeaderError> {
        let header = MessageHeader {
            is_le,
            message_type,
            message_flags,
            version,
            serial,
            fields,
        };
        match header.message_type {
            MessageType::MethodCall => {
                if !header.has_path() {
                    return Err(MessageHeaderError::MissingPath);
                }

                if !header.has_member() {
                    return Err(MessageHeaderError::MissingMember);
                }
            }
            MessageType::Signal => {
                if !header.has_path() {
                    return Err(MessageHeaderError::MissingPath);
                }

                if !header.has_interface() {
                    return Err(MessageHeaderError::MissingInterface);
                }

                if !header.has_member() {
                    return Err(MessageHeaderError::MissingMember);
                }
            }
            MessageType::Error => {
                if !header.has_error_name() {
                    return Err(MessageHeaderError::MissingErrorName);
                }

                if !header.has_replay_serial() {
                    return Err(MessageHeaderError::MissingReplySerial);
                }
            }
            MessageType::MethodReturn => {
                if !header.has_replay_serial() {
                    return Err(MessageHeaderError::MissingReplySerial);
                }
            }
        }

        Ok(header)
    }

    /// Get the `Path`, if there is one in the header field.
    pub fn get_path(&self) -> Option<&ObjectPath> {
        get_header!(self, Path);
    }

    /// It is true if the message contains an `Path` in the header fields.
    #[inline]
    pub fn has_path(&self) -> bool {
        self.get_path().is_some()
    }

    /// Get the `Interface`, if there is one in the header field.
    pub fn get_interface(&self) -> Option<&Interface> {
        get_header!(self, Interface);
    }

    /// It is true if the message contains an `Interface` in the header fields.
    #[inline]
    pub fn has_interface(&self) -> bool {
        self.get_interface().is_some()
    }

    ///headers Get the `Member`, if there is one in the header field.
    pub fn get_member(&self) -> Option<&Member> {
        get_header!(self, Member);
    }

    /// It is true if the message contains an `Member` in the header fields.
    #[inline]
    pub fn has_member(&self) -> bool {
        self.get_member().is_some()
    }

    /// Get the `ErrorName`, if there is one in the header field.
    pub fn get_error_name(&self) -> Option<&Error> {
        get_header!(self, ErrorName);
    }

    /// It is true if the message contains an `ErrorName` in the header fields.
    #[inline]
    pub fn has_error_name(&self) -> bool {
        self.get_error_name().is_some()
    }

    /// Get the `Destination`, if there is one in the header field.
    pub fn get_destination(&self) -> Option<&Bus> {
        get_header!(self, Destination);
    }

    /// Get the `Sender`, if there is one in the header field.
    pub fn get_sender(&self) -> Option<&Bus> {
        get_header!(self, Sender);
    }

    /// Get the serial number.
    pub fn get_serial(&self) -> u32 {
        self.serial
    }

    /// Get the `ReplySerial` number, if there is one in the header field.
    pub fn get_reply_serial(&self) -> Option<u32> {
        for h in &self.fields {
            if let MessageHeaderField::ReplySerial(serial) = h {
                return Some(*serial);
            }
        }

        None
    }

    /// It is true if the message contains an `ReplySerial` in the header fields.
    #[inline]
    pub fn has_replay_serial(&self) -> bool {
        self.get_reply_serial().is_some()
    }

    /// Get the `Signature`, if there is one in the header field.
    pub fn get_signature(&self) -> Option<&str> {
        get_header!(self, Signature);
    }

    /// It is true if the message contains an `Signature` in the header fields.
    #[inline]
    pub fn has_signature(&self) -> bool {
        self.get_signature().is_some()
    }

    /// Get the `UnixFDs`, if there is one in the header field.
    #[cfg(target_family = "unix")]
    pub fn get_unix_fds(&self) -> Option<u32> {
        for h in &self.fields {
            if let MessageHeaderField::UnixFDs(fds) = h {
                return Some(*fds);
            }
        }

        None
    }

    /// It is true if the message contains an `UnixFDs` in the header fields.
    #[cfg(target_family = "unix")]
    #[inline]
    pub fn has_unix_fds(&self) -> bool {
        self.get_unix_fds().is_some()
    }

    /// Create a message return from this `Message`.
    /// Only works if this `Message` is a MethodCall.
    pub fn method_return(&self) -> Result<Message, Message> {
        if let MessageType::MethodCall = self.message_type {
            let message_type = MessageType::MethodReturn;

            let message_flags = MessageFlags::NO_REPLY_EXPECTED;

            let mut fields = BTreeSet::new();

            if let Some(sender) = self.get_sender() {
                fields.insert(MessageHeaderField::Destination(sender.clone()));
            }

            if let Some(destination) = self.get_destination() {
                fields.insert(MessageHeaderField::Sender(destination.clone()));
            }

            fields.insert(MessageHeaderField::ReplySerial(self.get_serial()));

            let header = MessageHeader {
                is_le: self.is_le,
                message_type,
                message_flags,
                version: 1,
                serial: 0,
                fields,
            };
            Ok(Message {
                header,
                body: Vec::new(),
            })
        } else {
            Err(self.error(
                "org.freedesktop.DBus.Error.MessageType".try_into().unwrap(),
                "Message is not a method call".to_string(),
            ))
        }
    }

    /// Create a unknown property error message from this `Message`.
    pub fn unknown_property(&self, property: &str) -> Message {
        let message = format!("does not have a property {}", property);
        self.error(
            "org.freedesktop.DBus.Error.UnknownProperty"
                .try_into()
                .unwrap(),
            message,
        )
    }

    /// Create a unknown path error message from this `Message`.
    pub fn unknown_path(&self) -> Option<Message> {
        let path = self.get_path()?;
        let message = format!("does not have a path {}", path);
        let msg = self.error(
            "org.freedesktop.DBus.Error.UnknownPath".try_into().unwrap(),
            message,
        );
        Some(msg)
    }

    /// Create a unknown interface error message from this `Message`.
    pub fn unknown_interface(&self) -> Option<Message> {
        let interface = self.get_interface()?;
        let message = format!("does not have an interface {}", interface);
        let msg = self.error(
            "org.freedesktop.DBus.Error.UnknownInterface"
                .try_into()
                .unwrap(),
            message,
        );
        Some(msg)
    }

    /// Create a unknown member error message from this `Message`.
    pub fn unknown_member(&self) -> Option<Message> {
        let member = self.get_member()?;
        let message = format!("does not have a member {}", member);
        let msg = self.error(
            "org.freedesktop.DBus.Error.UnknownMember"
                .try_into()
                .unwrap(),
            message,
        );
        Some(msg)
    }

    /// Create an invalid args error message from this `Message`.
    pub fn invalid_args(&self, reason: String) -> Message {
        self.error(
            "org.freedesktop.DBus.Error.InvalidArgs".try_into().unwrap(),
            reason,
        )
    }

    /// Create an error message from this `Message`.
    pub fn error(&self, error: Error, message: String) -> Message {
        let message_type = MessageType::Error;

        let message_flags = MessageFlags::NO_REPLY_EXPECTED;

        let mut fields = BTreeSet::new();
        if let Some(sender) = self.get_sender() {
            fields.insert(MessageHeaderField::Destination(sender.clone()));
        }

        if let Some(destination) = self.get_destination() {
            fields.insert(MessageHeaderField::Sender(destination.clone()));
        }
        fields.insert(MessageHeaderField::ReplySerial(self.get_serial()));
        fields.insert(MessageHeaderField::ErrorName(error));

        let header = MessageHeader {
            is_le: self.is_le,
            message_type,
            message_flags,
            version: 1,
            serial: 0,
            fields,
        };
        Message {
            header,
            body: vec![Value::String(message)],
        }
    }

    /// Get the message type.
    pub fn get_type(&self) -> MessageType {
        self.message_type.clone()
    }
}