xmpp_parsers/
vcard_update.rs

1// Copyright (c) 2024 xmpp-rs contributors.
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//! This module implements vCard avatar updates defined in
8//! [XEP-0153](https://xmpp.org/extensions/xep-0153.html).
9//!
10//! Specifically, as it appears in `<presence>` stanzas, as shown in [XEP-0153 example 3](https://xmpp.org/extensions/xep-0153.html#example-3).
11//!
12//! For [XEP-0054](https://xmpp.org/extensions/xep-0054.html) vCard support,
13//! see [`vcard`][crate::vcard] module.
14
15use xso::{text::FixedHex, AsXml, FromXml};
16
17use crate::ns;
18
19/// The presence payload for an avatar VCard update
20#[derive(FromXml, AsXml, Debug, PartialEq, Clone)]
21#[xml(namespace = ns::VCARD_UPDATE, name = "x")]
22pub struct VCardUpdate {
23    /// The photo element. Is empty if "a client is not yet ready to advertise an image".
24    #[xml(child(default))]
25    pub photo: Option<Photo>,
26}
27
28/// The photo element containing the avatar metadata
29#[derive(FromXml, AsXml, PartialEq, Debug, Clone)]
30#[xml(namespace = ns::VCARD_UPDATE, name = "photo")]
31pub struct Photo {
32    /// The SHA1 hash of the avatar. Empty when there is no photo.
33    #[xml(text(codec = FixedHex<20>))]
34    pub data: Option<[u8; 20]>,
35}
36
37#[cfg(test)]
38mod tests {
39    use super::*;
40    use core::str::FromStr;
41    use minidom::Element;
42
43    #[test]
44    fn test_vcard_update() {
45        // Test xml stolen from https://xmpp.org/extensions/xep-0153.html#example-3
46        // Changes: I did set the last d to uppercase to try to trip up a potentially case-sensitive parser.
47        let test_vcard = r"<x xmlns='vcard-temp:x:update'>
48    <photo>01b87fcd030b72895ff8e88db57ec525450f000D</photo>
49  </x>";
50
51        let test_vcard = Element::from_str(&test_vcard).expect("Failed to parse XML");
52        let test_vcard = VCardUpdate::try_from(test_vcard).expect("Failed to parse vCardUpdate");
53
54        let photo = test_vcard.photo.expect("No photo found");
55
56        assert_eq!(
57            photo.data,
58            Some([
59                0x01, 0xb8, 0x7f, 0xcd, 0x03, 0x0b, 0x72, 0x89, 0x5f, 0xf8, 0xe8, 0x8d, 0xb5, 0x7e,
60                0xc5, 0x25, 0x45, 0x0f, 0x00, 0x0d
61            ])
62        );
63    }
64
65    #[test]
66    fn test_vcard_update_empty() {
67        // Test xml stolen from https://xmpp.org/extensions/xep-0153.html#example-7
68        let test_vcard = r"<x xmlns='vcard-temp:x:update'><photo/></x>";
69
70        let test_vcard = Element::from_str(&test_vcard).expect("Failed to parse XML");
71        let test_vcard = VCardUpdate::try_from(test_vcard).expect("Failed to parse vCardUpdate");
72
73        let photo = test_vcard.photo.expect("No photo found");
74
75        assert_eq!(photo.data, None)
76    }
77}
xmpp_parsers/vcard_update.rs

xmpp_parsers/
vcard_update.rs
