xmpp_parsers/
private.rs

1// Copyright (c) 2023 xmppftw <xmppftw@kl.netlib.re>
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
7//!
8//! This module implements [Private XML Storage](https://xmpp.org/extensions/xep-0049.html) from
9//! XEP-0049.
10//!
11//! However, only legacy bookmarks storage from [XEP-0048
12//! v1.0](https://xmpp.org/extensions/attic/xep-0048-1.0.html) is supported at the moment.
13//! This should only be used when `urn:xmpp:bookmarks:1#compat` is not advertised on the user's
14//! BareJID in a disco info request.
15//!
16//! See [ModernXMPP docs](https://docs.modernxmpp.org/client/groupchat/#bookmarks) on how to handle
17//! all historic and newer specifications for your clients handling of chatroom bookmarks.
18//!
19//! This module uses the legacy bookmarks [`bookmarks::Conference`][crate::bookmarks::Conference]
20//! struct as stored in a legacy [`bookmarks::Storage`][crate::bookmarks::Storage] struct.
21
22use xso::{AsXml, FromXml};
23
24use crate::{
25    bookmarks::Storage,
26    iq::{IqGetPayload, IqResultPayload, IqSetPayload},
27    ns,
28};
29
30/// A Private XML Storage query. Only supports XEP-0048 bookmarks.
31#[derive(FromXml, AsXml, PartialEq, Debug, Clone)]
32#[xml(namespace = ns::PRIVATE, name = "query")]
33pub struct Query {
34    /// XEP-0048 bookmarks in a [`Storage`] element
35    #[xml(child)]
36    pub storage: Storage,
37}
38
39impl IqSetPayload for Query {}
40impl IqGetPayload for Query {}
41impl IqResultPayload for Query {}
42
43#[cfg(test)]
44mod tests {
45    use super::*;
46    use minidom::Element;
47    use xso::error::{Error, FromElementError};
48
49    #[test]
50    fn test_invalid_duplicate_child() {
51        let elem: Element = "<query xmlns='jabber:iq:private'><storage xmlns='storage:bookmarks'/><storage xmlns='storage:bookmarks'/></query>"
52            .parse()
53            .unwrap();
54        let error = Query::try_from(elem).unwrap_err();
55        let message = match error {
56            FromElementError::Invalid(Error::Other(string)) => string,
57            _ => panic!(),
58        };
59        assert_eq!(
60            message,
61            "Query element must not have more than one child in field 'storage'."
62        );
63    }
64}
xmpp_parsers/private.rs

xmpp_parsers/
private.rs
