xmpp_parsers/
jingle.rs

1// Copyright (c) 2017 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7use xso::{AsXml, FromXml};
8
9use crate::iq::IqSetPayload;
10use crate::jingle_grouping::Group;
11use crate::jingle_ibb::Transport as IbbTransport;
12use crate::jingle_ice_udp::Transport as IceUdpTransport;
13use crate::jingle_rtp::Description as RtpDescription;
14use crate::jingle_s5b::Transport as Socks5Transport;
15use crate::ns;
16use alloc::{collections::BTreeMap, fmt};
17use jid::Jid;
18use minidom::Element;
19use xso::error::Error;
20
21generate_attribute!(
22    /// The action attribute.
23    Action, "action", {
24        /// Accept a content-add action received from another party.
25        ContentAccept => "content-accept",
26
27        /// Add one or more new content definitions to the session.
28        ContentAdd => "content-add",
29
30        /// Change the directionality of media sending.
31        ContentModify => "content-modify",
32
33        /// Reject a content-add action received from another party.
34        ContentReject => "content-reject",
35
36        /// Remove one or more content definitions from the session.
37        ContentRemove => "content-remove",
38
39        /// Exchange information about parameters for an application type.
40        DescriptionInfo => "description-info",
41
42        /// Exchange information about security preconditions.
43        SecurityInfo => "security-info",
44
45        /// Definitively accept a session negotiation.
46        SessionAccept => "session-accept",
47
48        /// Send session-level information, such as a ping or a ringing message.
49        SessionInfo => "session-info",
50
51        /// Request negotiation of a new Jingle session.
52        SessionInitiate => "session-initiate",
53
54        /// End an existing session.
55        SessionTerminate => "session-terminate",
56
57        /// Accept a transport-replace action received from another party.
58        TransportAccept => "transport-accept",
59
60        /// Exchange transport candidates.
61        TransportInfo => "transport-info",
62
63        /// Reject a transport-replace action received from another party.
64        TransportReject => "transport-reject",
65
66        /// Redefine a transport method or replace it with a different method.
67        TransportReplace => "transport-replace",
68    }
69);
70
71generate_attribute!(
72    /// Which party originally generated the content type.
73    Creator, "creator", {
74        /// This content was created by the initiator of this session.
75        Initiator => "initiator",
76
77        /// This content was created by the responder of this session.
78        Responder => "responder",
79    }
80);
81
82generate_attribute!(
83    /// Which parties in the session will be generating content.
84    Senders, "senders", {
85        /// Both parties can send for this content.
86        Both => "both",
87
88        /// Only the initiator can send for this content.
89        Initiator => "initiator",
90
91        /// No one can send for this content.
92        None => "none",
93
94        /// Only the responder can send for this content.
95        Responder => "responder",
96    }, Default = Both
97);
98
99generate_attribute!(
100    /// How the content definition is to be interpreted by the recipient. The
101    /// meaning of this attribute matches the "Content-Disposition" header as
102    /// defined in RFC 2183 and applied to SIP by RFC 3261.
103    ///
104    /// Possible values are defined here:
105    /// <https://www.iana.org/assignments/cont-disp/cont-disp.xhtml>
106    Disposition, "disposition", {
107        /// Displayed automatically.
108        Inline => "inline",
109
110        /// User controlled display.
111        Attachment => "attachment",
112
113        /// Process as form response.
114        FormData => "form-data",
115
116        /// Tunneled content to be processed silently.
117        Signal => "signal",
118
119        /// The body is a custom ring tone to alert the user.
120        Alert => "alert",
121
122        /// The body is displayed as an icon to the user.
123        Icon => "icon",
124
125        /// The body should be displayed to the user.
126        Render => "render",
127
128        /// The body contains a list of URIs that indicates the recipients of
129        /// the request.
130        RecipientListHistory => "recipient-list-history",
131
132        /// The body describes a communications session, for example, an
133        /// [RFC2327](https://www.rfc-editor.org/rfc/rfc2327) SDP body.
134        Session => "session",
135
136        /// Authenticated Identity Body.
137        Aib => "aib",
138
139        /// The body describes an early communications session, for example,
140        /// and [RFC2327](https://www.rfc-editor.org/rfc/rfc2327) SDP body.
141        EarlySession => "early-session",
142
143        /// The body includes a list of URIs to which URI-list services are to
144        /// be applied.
145        RecipientList => "recipient-list",
146
147        /// The payload of the message carrying this Content-Disposition header
148        /// field value is an Instant Message Disposition Notification as
149        /// requested in the corresponding Instant Message.
150        Notification => "notification",
151
152        /// The body needs to be handled according to a reference to the body
153        /// that is located in the same SIP message as the body.
154        ByReference => "by-reference",
155
156        /// The body contains information associated with an Info Package.
157        InfoPackage => "info-package",
158
159        /// The body describes either metadata about the RS or the reason for
160        /// the metadata snapshot request as determined by the MIME value
161        /// indicated in the Content-Type.
162        RecordingSession => "recording-session",
163    }, Default = Session
164);
165
166generate_id!(
167    /// An unique identifier in a session, referencing a
168    /// [struct.Content.html](Content element).
169    ContentId
170);
171
172/// Enum wrapping all of the various supported descriptions of a Content.
173#[derive(AsXml, Debug, Clone, PartialEq)]
174#[xml()]
175pub enum Description {
176    /// Jingle RTP Sessions (XEP-0167) description.
177    #[xml(transparent)]
178    Rtp(RtpDescription),
179
180    /// To be used for any description that isn’t known at compile-time.
181    // TODO: replace with `#[xml(element, name = ..)]` once we have it.
182    #[xml(transparent)]
183    Unknown(Element),
184}
185
186impl TryFrom<Element> for Description {
187    type Error = Error;
188
189    fn try_from(elem: Element) -> Result<Description, Error> {
190        Ok(if elem.is("description", ns::JINGLE_RTP) {
191            Description::Rtp(RtpDescription::try_from(elem)?)
192        } else if elem.name() == "description" {
193            Description::Unknown(elem)
194        } else {
195            return Err(Error::Other("Invalid description."));
196        })
197    }
198}
199
200impl ::xso::FromXml for Description {
201    type Builder = ::xso::minidom_compat::FromEventsViaElement<Description>;
202
203    fn from_events(
204        qname: ::xso::exports::rxml::QName,
205        attrs: ::xso::exports::rxml::AttrMap,
206    ) -> Result<Self::Builder, ::xso::error::FromEventsError> {
207        if qname.1 != "description" {
208            return Err(::xso::error::FromEventsError::Mismatch { name: qname, attrs });
209        }
210        Self::Builder::new(qname, attrs)
211    }
212}
213
214impl From<RtpDescription> for Description {
215    fn from(desc: RtpDescription) -> Description {
216        Description::Rtp(desc)
217    }
218}
219
220/// Enum wrapping all of the various supported transports of a Content.
221#[derive(AsXml, Debug, Clone, PartialEq)]
222#[xml()]
223pub enum Transport {
224    /// Jingle ICE-UDP Bytestreams (XEP-0176) transport.
225    #[xml(transparent)]
226    IceUdp(IceUdpTransport),
227
228    /// Jingle In-Band Bytestreams (XEP-0261) transport.
229    #[xml(transparent)]
230    Ibb(IbbTransport),
231
232    /// Jingle SOCKS5 Bytestreams (XEP-0260) transport.
233    #[xml(transparent)]
234    Socks5(Socks5Transport),
235
236    /// To be used for any transport that isn’t known at compile-time.
237    // TODO: replace with `#[xml(element, name = ..)]` once we have it.
238    #[xml(transparent)]
239    Unknown(Element),
240}
241
242impl TryFrom<Element> for Transport {
243    type Error = Error;
244
245    fn try_from(elem: Element) -> Result<Transport, Error> {
246        Ok(if elem.is("transport", ns::JINGLE_ICE_UDP) {
247            Transport::IceUdp(IceUdpTransport::try_from(elem)?)
248        } else if elem.is("transport", ns::JINGLE_IBB) {
249            Transport::Ibb(IbbTransport::try_from(elem)?)
250        } else if elem.is("transport", ns::JINGLE_S5B) {
251            Transport::Socks5(Socks5Transport::try_from(elem)?)
252        } else if elem.name() == "transport" {
253            Transport::Unknown(elem)
254        } else {
255            return Err(Error::Other("Invalid transport."));
256        })
257    }
258}
259
260impl ::xso::FromXml for Transport {
261    type Builder = ::xso::minidom_compat::FromEventsViaElement<Transport>;
262
263    fn from_events(
264        qname: ::xso::exports::rxml::QName,
265        attrs: ::xso::exports::rxml::AttrMap,
266    ) -> Result<Self::Builder, ::xso::error::FromEventsError> {
267        if qname.1 != "transport" {
268            return Err(::xso::error::FromEventsError::Mismatch { name: qname, attrs });
269        }
270        Self::Builder::new(qname, attrs)
271    }
272}
273
274impl From<IceUdpTransport> for Transport {
275    fn from(transport: IceUdpTransport) -> Transport {
276        Transport::IceUdp(transport)
277    }
278}
279
280impl From<IbbTransport> for Transport {
281    fn from(transport: IbbTransport) -> Transport {
282        Transport::Ibb(transport)
283    }
284}
285
286impl From<Socks5Transport> for Transport {
287    fn from(transport: Socks5Transport) -> Transport {
288        Transport::Socks5(transport)
289    }
290}
291
292/// A security element inside a Jingle content, stubbed for now.
293#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
294#[xml(namespace = ns::JINGLE, name = "security")]
295pub struct Security;
296
297/// Describes a session’s content, there can be multiple content in one
298/// session.
299#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
300#[xml(namespace = ns::JINGLE, name = "content")]
301pub struct Content {
302    /// Who created this content.
303    #[xml(attribute)]
304    pub creator: Creator,
305
306    /// How the content definition is to be interpreted by the recipient.
307    #[xml(attribute(default))]
308    pub disposition: Disposition,
309
310    /// A per-session unique identifier for this content.
311    #[xml(attribute)]
312    pub name: ContentId,
313
314    /// Who can send data for this content.
315    #[xml(attribute(default))]
316    pub senders: Senders,
317
318    /// What to send.
319    #[xml(child(default))]
320    pub description: Option<Description>,
321
322    /// How to send it.
323    #[xml(child(default))]
324    pub transport: Option<Transport>,
325
326    /// With which security.
327    #[xml(child(default))]
328    pub security: Option<Security>,
329}
330
331impl Content {
332    /// Create a new content.
333    pub fn new(creator: Creator, name: ContentId) -> Content {
334        Content {
335            creator,
336            name,
337            disposition: Disposition::Session,
338            senders: Senders::Both,
339            description: None,
340            transport: None,
341            security: None,
342        }
343    }
344
345    /// Set how the content is to be interpreted by the recipient.
346    pub fn with_disposition(mut self, disposition: Disposition) -> Content {
347        self.disposition = disposition;
348        self
349    }
350
351    /// Specify who can send data for this content.
352    pub fn with_senders(mut self, senders: Senders) -> Content {
353        self.senders = senders;
354        self
355    }
356
357    /// Set the description of this content.
358    pub fn with_description<D: Into<Description>>(mut self, description: D) -> Content {
359        self.description = Some(description.into());
360        self
361    }
362
363    /// Set the transport of this content.
364    pub fn with_transport<T: Into<Transport>>(mut self, transport: T) -> Content {
365        self.transport = Some(transport.into());
366        self
367    }
368
369    /// Set the security of this content.
370    pub fn with_security(mut self, security: Security) -> Content {
371        self.security = Some(security);
372        self
373    }
374}
375
376/// Lists the possible reasons to be included in a Jingle iq.
377#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
378#[xml(namespace = ns::JINGLE)]
379pub enum Reason {
380    /// The party prefers to use an existing session with the peer rather than
381    /// initiate a new session; the Jingle session ID of the alternative
382    /// session SHOULD be provided as the XML character data of the \<sid/\>
383    /// child.
384    #[xml(name = "alternative-session")]
385    AlternativeSession {
386        /// Session ID of the alternative session.
387        #[xml(extract(namespace = ns::JINGLE, name = "sid", default, fields(text(type_ = String))))]
388        sid: Option<String>,
389    },
390
391    /// The party is busy and cannot accept a session.
392    #[xml(name = "busy")]
393    Busy,
394
395    /// The initiator wishes to formally cancel the session initiation request.
396    #[xml(name = "cancel")]
397    Cancel,
398
399    /// The action is related to connectivity problems.
400    #[xml(name = "connectivity-error")]
401    ConnectivityError,
402
403    /// The party wishes to formally decline the session.
404    #[xml(name = "decline")]
405    Decline,
406
407    /// The session length has exceeded a pre-defined time limit (e.g., a
408    /// meeting hosted at a conference service).
409    #[xml(name = "expired")]
410    Expired,
411
412    /// The party has been unable to initialize processing related to the
413    /// application type.
414    #[xml(name = "failed-application")]
415    FailedApplication,
416
417    /// The party has been unable to establish connectivity for the transport
418    /// method.
419    #[xml(name = "failed-transport")]
420    FailedTransport,
421
422    /// The action is related to a non-specific application error.
423    #[xml(name = "general-error")]
424    GeneralError,
425
426    /// The entity is going offline or is no longer available.
427    #[xml(name = "gone")]
428    Gone,
429
430    /// The party supports the offered application type but does not support
431    /// the offered or negotiated parameters.
432    #[xml(name = "incompatible-parameters")]
433    IncompatibleParameters,
434
435    /// The action is related to media processing problems.
436    #[xml(name = "media-error")]
437    MediaError,
438
439    /// The action is related to a violation of local security policies.
440    #[xml(name = "security-error")]
441    SecurityError,
442
443    /// The action is generated during the normal course of state management
444    /// and does not reflect any error.
445    #[xml(name = "success")]
446    Success,
447
448    /// A request has not been answered so the sender is timing out the
449    /// request.
450    #[xml(name = "timeout")]
451    Timeout,
452
453    /// The party supports none of the offered application types.
454    #[xml(name = "unsupported-applications")]
455    UnsupportedApplications,
456
457    /// The party supports none of the offered transport methods.
458    #[xml(name = "unsupported-transports")]
459    UnsupportedTransports,
460}
461
462type Lang = String;
463
464/// Informs the recipient of something.
465#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
466#[xml(namespace = ns::JINGLE, name = "reason")]
467pub struct ReasonElement {
468    /// The list of possible reasons to be included in a Jingle iq.
469    #[xml(child)]
470    pub reason: Reason,
471
472    /// A human-readable description of this reason.
473    #[xml(extract(n = .., namespace = ns::JINGLE, name = "text", fields(
474        attribute(type_ = String, name = "xml:lang", default),
475        text(type_ = String),
476    )))]
477    pub texts: BTreeMap<Lang, String>,
478}
479
480impl fmt::Display for ReasonElement {
481    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
482        write!(fmt, "{}", Element::from(self.reason.clone()).name())?;
483        if let Some(text) = self.texts.get("en") {
484            write!(fmt, ": {}", text)?;
485        } else if let Some(text) = self.texts.get("") {
486            write!(fmt, ": {}", text)?;
487        }
488        Ok(())
489    }
490}
491
492generate_id!(
493    /// Unique identifier for a session between two JIDs.
494    SessionId
495);
496
497/// The main Jingle container, to be included in an iq stanza.
498#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
499#[xml(namespace = ns::JINGLE, name = "jingle")]
500pub struct Jingle {
501    /// The action to execute on both ends.
502    #[xml(attribute)]
503    pub action: Action,
504
505    /// Who the initiator is.
506    #[xml(attribute(default))]
507    pub initiator: Option<Jid>,
508
509    /// Who the responder is.
510    #[xml(attribute(default))]
511    pub responder: Option<Jid>,
512
513    /// Unique session identifier between two entities.
514    #[xml(attribute)]
515    pub sid: SessionId,
516
517    /// A list of contents to be negotiated in this session.
518    #[xml(child(n = ..))]
519    pub contents: Vec<Content>,
520
521    /// An optional reason.
522    #[xml(child(default))]
523    pub reason: Option<ReasonElement>,
524
525    /// An optional grouping.
526    #[xml(child(default))]
527    pub group: Option<Group>,
528
529    /// Payloads to be included.
530    #[xml(child(n = ..))]
531    pub other: Vec<Element>,
532}
533
534impl IqSetPayload for Jingle {}
535
536impl Jingle {
537    /// Create a new Jingle element.
538    pub fn new(action: Action, sid: SessionId) -> Jingle {
539        Jingle {
540            action,
541            sid,
542            initiator: None,
543            responder: None,
544            contents: Vec::new(),
545            reason: None,
546            group: None,
547            other: Vec::new(),
548        }
549    }
550
551    /// Set the initiator’s JID.
552    pub fn with_initiator(mut self, initiator: Jid) -> Jingle {
553        self.initiator = Some(initiator);
554        self
555    }
556
557    /// Set the responder’s JID.
558    pub fn with_responder(mut self, responder: Jid) -> Jingle {
559        self.responder = Some(responder);
560        self
561    }
562
563    /// Add a content to this Jingle container.
564    pub fn add_content(mut self, content: Content) -> Jingle {
565        self.contents.push(content);
566        self
567    }
568
569    /// Set the reason in this Jingle container.
570    pub fn set_reason(mut self, reason: ReasonElement) -> Jingle {
571        self.reason = Some(reason);
572        self
573    }
574
575    /// Set the grouping in this Jingle container.
576    pub fn set_group(mut self, group: Group) -> Jingle {
577        self.group = Some(group);
578        self
579    }
580}
581
582#[cfg(test)]
583mod tests {
584    use super::*;
585    use xso::error::FromElementError;
586
587    #[cfg(target_pointer_width = "32")]
588    #[test]
589    fn test_size() {
590        assert_size!(Action, 1);
591        assert_size!(Creator, 1);
592        assert_size!(Senders, 1);
593        assert_size!(Disposition, 1);
594        assert_size!(ContentId, 12);
595        assert_size!(Content, 156);
596        assert_size!(Reason, 12);
597        assert_size!(ReasonElement, 24);
598        assert_size!(SessionId, 12);
599        assert_size!(Jingle, 112);
600    }
601
602    #[cfg(target_pointer_width = "64")]
603    #[test]
604    fn test_size() {
605        assert_size!(Action, 1);
606        assert_size!(Creator, 1);
607        assert_size!(Senders, 1);
608        assert_size!(Disposition, 1);
609        assert_size!(ContentId, 24);
610        assert_size!(Content, 312);
611        assert_size!(Reason, 24);
612        assert_size!(ReasonElement, 48);
613        assert_size!(SessionId, 24);
614        assert_size!(Jingle, 224);
615    }
616
617    #[test]
618    fn test_simple() {
619        let elem: Element =
620            "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'/>"
621                .parse()
622                .unwrap();
623        let jingle = Jingle::try_from(elem).unwrap();
624        assert_eq!(jingle.action, Action::SessionInitiate);
625        assert_eq!(jingle.sid, SessionId(String::from("coucou")));
626    }
627
628    #[test]
629    fn test_invalid_jingle() {
630        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1'/>".parse().unwrap();
631        let error = Jingle::try_from(elem).unwrap_err();
632        let message = match error {
633            FromElementError::Invalid(Error::Other(string)) => string,
634            _ => panic!(),
635        };
636        assert_eq!(
637            message,
638            "Required attribute field 'action' on Jingle element missing."
639        );
640
641        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-info'/>"
642            .parse()
643            .unwrap();
644        let error = Jingle::try_from(elem).unwrap_err();
645        let message = match error {
646            FromElementError::Invalid(Error::Other(string)) => string,
647            _ => panic!(),
648        };
649        assert_eq!(
650            message,
651            "Required attribute field 'sid' on Jingle element missing."
652        );
653
654        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='coucou' sid='coucou'/>"
655            .parse()
656            .unwrap();
657        let error = Jingle::try_from(elem).unwrap_err();
658        let message = match error {
659            FromElementError::Invalid(Error::TextParseError(string)) => string,
660            _ => panic!(),
661        };
662        assert_eq!(message.to_string(), "Unknown value for 'action' attribute.");
663    }
664
665    #[test]
666    fn test_content() {
667        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content creator='initiator' name='coucou'><description/><transport xmlns='urn:xmpp:jingle:transports:stub:0'/></content></jingle>".parse().unwrap();
668        let jingle = Jingle::try_from(elem).unwrap();
669        assert_eq!(jingle.contents[0].creator, Creator::Initiator);
670        assert_eq!(jingle.contents[0].name, ContentId(String::from("coucou")));
671        assert_eq!(jingle.contents[0].senders, Senders::Both);
672        assert_eq!(jingle.contents[0].disposition, Disposition::Session);
673
674        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content creator='initiator' name='coucou' senders='both'><description/><transport xmlns='urn:xmpp:jingle:transports:stub:0'/></content></jingle>".parse().unwrap();
675        let jingle = Jingle::try_from(elem).unwrap();
676        assert_eq!(jingle.contents[0].senders, Senders::Both);
677
678        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content creator='initiator' name='coucou' disposition='early-session'><description/><transport xmlns='urn:xmpp:jingle:transports:stub:0'/></content></jingle>".parse().unwrap();
679        let jingle = Jingle::try_from(elem).unwrap();
680        assert_eq!(jingle.contents[0].disposition, Disposition::EarlySession);
681    }
682
683    #[test]
684    fn test_invalid_content() {
685        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content/></jingle>".parse().unwrap();
686        let error = Jingle::try_from(elem).unwrap_err();
687        let message = match error {
688            FromElementError::Invalid(Error::Other(string)) => string,
689            _ => panic!(),
690        };
691        assert_eq!(
692            message,
693            "Required attribute field 'creator' on Content element missing."
694        );
695
696        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content creator='initiator'/></jingle>".parse().unwrap();
697        let error = Jingle::try_from(elem).unwrap_err();
698        let message = match error {
699            FromElementError::Invalid(Error::Other(string)) => string,
700            _ => panic!(),
701        };
702        assert_eq!(
703            message,
704            "Required attribute field 'name' on Content element missing."
705        );
706
707        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content creator='coucou' name='coucou'/></jingle>".parse().unwrap();
708        let error = Jingle::try_from(elem).unwrap_err();
709        let message = match error {
710            FromElementError::Invalid(Error::TextParseError(string)) => string,
711            other => panic!("unexpected result: {:?}", other),
712        };
713        assert_eq!(
714            message.to_string(),
715            "Unknown value for 'creator' attribute."
716        );
717
718        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content creator='initiator' name='coucou' senders='coucou'/></jingle>".parse().unwrap();
719        let error = Jingle::try_from(elem).unwrap_err();
720        let message = match error {
721            FromElementError::Invalid(Error::TextParseError(string)) => string,
722            _ => panic!(),
723        };
724        assert_eq!(
725            message.to_string(),
726            "Unknown value for 'senders' attribute."
727        );
728
729        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><content creator='initiator' name='coucou' senders=''/></jingle>".parse().unwrap();
730        let error = Jingle::try_from(elem).unwrap_err();
731        let message = match error {
732            FromElementError::Invalid(Error::TextParseError(string)) => string,
733            _ => panic!(),
734        };
735        assert_eq!(
736            message.to_string(),
737            "Unknown value for 'senders' attribute."
738        );
739    }
740
741    #[test]
742    fn test_reason() {
743        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><reason><success/></reason></jingle>".parse().unwrap();
744        let jingle = Jingle::try_from(elem).unwrap();
745        let reason = jingle.reason.unwrap();
746        assert_eq!(reason.reason, Reason::Success);
747        assert_eq!(reason.texts, BTreeMap::new());
748
749        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><reason><success/><text>coucou</text></reason></jingle>".parse().unwrap();
750        let jingle = Jingle::try_from(elem).unwrap();
751        let reason = jingle.reason.unwrap();
752        assert_eq!(reason.reason, Reason::Success);
753        assert_eq!(reason.texts.get(""), Some(&String::from("coucou")));
754    }
755
756    #[test]
757    fn test_missing_reason_text() {
758        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><reason/></jingle>".parse().unwrap();
759        let error = Jingle::try_from(elem).unwrap_err();
760        let message = match error {
761            FromElementError::Invalid(Error::Other(string)) => string,
762            _ => panic!(),
763        };
764        assert_eq!(
765            message,
766            "Missing child field 'reason' in ReasonElement element."
767        );
768    }
769
770    #[test]
771    #[cfg_attr(feature = "disable-validation", should_panic = "Result::unwrap_err")]
772    fn test_invalid_child_in_reason() {
773        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><reason><decline/><a/></reason></jingle>".parse().unwrap();
774        let error = Jingle::try_from(elem).unwrap_err();
775        let message = match error {
776            FromElementError::Invalid(Error::Other(string)) => string,
777            _ => panic!(),
778        };
779        assert_eq!(message, "Unknown child in ReasonElement element.");
780    }
781
782    #[test]
783    fn test_multiple_reason_children() {
784        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><reason><decline/></reason><reason/></jingle>".parse().unwrap();
785        let error = Jingle::try_from(elem).unwrap_err();
786        let message = match error {
787            FromElementError::Invalid(Error::Other(string)) => string,
788            _ => panic!(),
789        };
790        assert_eq!(
791            message,
792            "Jingle element must not have more than one child in field 'reason'."
793        );
794
795        // TODO: Reenable this test once xso is able to validate that no more than one text is
796        // there for every xml:lang.
797        /*
798        let elem: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='coucou'><reason><decline/><text/><text/></reason></jingle>".parse().unwrap();
799        let error = Jingle::try_from(elem).unwrap_err();
800        let message = match error {
801            FromElementError::Invalid(Error::Other(string)) => string,
802            _ => panic!(),
803        };
804        assert_eq!(message, "Text element present twice for the same xml:lang.");
805        */
806    }
807
808    #[test]
809    fn test_serialize_jingle() {
810        let reference: Element = "<jingle xmlns='urn:xmpp:jingle:1' action='session-initiate' sid='a73sjjvkla37jfea'><content xmlns='urn:xmpp:jingle:1' creator='initiator' name='this-is-a-stub'><description xmlns='urn:xmpp:jingle:apps:stub:0'/><transport xmlns='urn:xmpp:jingle:transports:stub:0'/></content></jingle>"
811        .parse()
812        .unwrap();
813
814        let jingle = Jingle {
815            action: Action::SessionInitiate,
816            initiator: None,
817            responder: None,
818            sid: SessionId(String::from("a73sjjvkla37jfea")),
819            contents: vec![Content {
820                creator: Creator::Initiator,
821                disposition: Disposition::default(),
822                name: ContentId(String::from("this-is-a-stub")),
823                senders: Senders::default(),
824                description: Some(Description::Unknown(
825                    Element::builder("description", "urn:xmpp:jingle:apps:stub:0").build(),
826                )),
827                transport: Some(Transport::Unknown(
828                    Element::builder("transport", "urn:xmpp:jingle:transports:stub:0").build(),
829                )),
830                security: None,
831            }],
832            reason: None,
833            group: None,
834            other: vec![],
835        };
836        let serialized: Element = jingle.into();
837        assert_eq!(serialized, reference);
838    }
839}
xmpp_parsers/jingle.rs

xmpp_parsers/
jingle.rs
