xmpp-rs/src/lib.rs

//! A crate parsing common XMPP elements into Rust structures.
//!
//! Each module implements the `TryFrom<&minidom::Element>` trait, which takes
//! a minidom `Element` reference and returns a `Result`.
//!
//! Parsed structs can then be manipulated manually, and must be serialised
//! back before being sent over the wire.

// Copyright (c) 2017 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
// Copyright (c) 2017 Maxime “pep” Buquet <pep+code@bouah.net>
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#![feature(try_from)]

extern crate minidom;
extern crate jid;
extern crate base64;
extern crate digest;
extern crate sha_1;
extern crate sha2;
extern crate sha3;
extern crate blake2;
extern crate chrono;

macro_rules! get_attr {
    ($elem:ident, $attr:tt, $type:tt) => (
        get_attr!($elem, $attr, $type, value, value.parse()?)
    );
    ($elem:ident, $attr:tt, optional, $value:ident, $func:expr) => (
        match $elem.attr($attr) {
            Some($value) => Some($func),
            None => None,
        }
    );
    ($elem:ident, $attr:tt, required, $value:ident, $func:expr) => (
        match $elem.attr($attr) {
            Some($value) => $func,
            None => return Err(Error::ParseError(concat!("Required attribute '", $attr, "' missing."))),
        }
    );
    ($elem:ident, $attr:tt, default, $value:ident, $func:expr) => (
        match $elem.attr($attr) {
            Some($value) => $func,
            None => Default::default(),
        }
    );
}

macro_rules! generate_attribute {
    ($elem:ident, $name:tt, {$($a:ident => $b:tt),+,}) => (
        generate_attribute!($elem, $name, {$($a => $b),+});
    );
    ($elem:ident, $name:tt, {$($a:ident => $b:tt),+,}, Default = $default:ident) => (
        generate_attribute!($elem, $name, {$($a => $b),+}, Default = $default);
    );
    ($elem:ident, $name:tt, {$($a:ident => $b:tt),+}) => (
        #[derive(Debug, Clone, PartialEq)]
        pub enum $elem {
            $($a),+
        }
        impl FromStr for $elem {
            type Err = Error;
            fn from_str(s: &str) -> Result<$elem, Error> {
                Ok(match s {
                    $($b => $elem::$a),+,
                    _ => return Err(Error::ParseError(concat!("Unknown value for '", $name, "' attribute."))),
                })
            }
        }
        impl IntoAttributeValue for $elem {
            fn into_attribute_value(self) -> Option<String> {
                Some(String::from(match self {
                    $($elem::$a => $b),+
                }))
            }
        }
    );
    ($elem:ident, $name:tt, {$($a:ident => $b:tt),+}, Default = $default:ident) => (
        #[derive(Debug, Clone, PartialEq)]
        pub enum $elem {
            $($a),+
        }
        impl FromStr for $elem {
            type Err = Error;
            fn from_str(s: &str) -> Result<$elem, Error> {
                Ok(match s {
                    $($b => $elem::$a),+,
                    _ => return Err(Error::ParseError(concat!("Unknown value for '", $name, "' attribute."))),
                })
            }
        }
        impl IntoAttributeValue for $elem {
            #[allow(unreachable_patterns)]
            fn into_attribute_value(self) -> Option<String> {
                Some(String::from(match self {
                    $elem::$default => return None,
                    $($elem::$a => $b),+
                }))
            }
        }
        impl Default for $elem {
            fn default() -> $elem {
                $elem::$default
            }
        }
    );
}

/// Error type returned by every parser on failure.
pub mod error;
/// XML namespace definitions used through XMPP.
pub mod ns;

/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
pub mod message;
/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
pub mod presence;
/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
pub mod iq;
/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
pub mod stanza_error;

/// RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence
pub mod roster;

/// XEP-0004: Data Forms
pub mod data_forms;

/// XEP-0030: Service Discovery
pub mod disco;

/// XEP-0045: Multi-User Chat
pub mod muc;

/// XEP-0047: In-Band Bytestreams
pub mod ibb;

/// XEP-0059: Result Set Management
pub mod rsm;

/// XEP-0060: Publish-Subscribe
pub mod pubsub;

/// XEP-0085: Chat State Notifications
pub mod chatstates;

/// XEP-0115: Entity Capabilities
pub mod caps;

/// XEP-0166: Jingle
pub mod jingle;

/// XEP-0184: Message Delivery Receipts
pub mod receipts;

/// XEP-0199: XMPP Ping
pub mod ping;

/// XEP-0203: Delayed Delivery
pub mod delay;

/// XEP-0221: Data Forms Media Element
pub mod media_element;

/// XEP-0224: Attention
pub mod attention;

/// XEP-0234: Jingle File Transfer
pub mod jingle_ft;

/// XEP-0260: Jingle SOCKS5 Bytestreams Transport Method
pub mod jingle_s5b;

/// XEP-0261: Jingle In-Band Bytestreams Transport Method
pub mod jingle_ibb;

/// XEP-0297: Stanza Forwarding
pub mod forwarding;

/// XEP-0300: Use of Cryptographic Hash Functions in XMPP
pub mod hashes;

/// XEP-0308: Last Message Correction
pub mod message_correct;

/// XEP-0313: Message Archive Management
pub mod mam;

/// XEP-0319: Last User Interaction in Presence
pub mod idle;

/// XEP-0359: Unique and Stable Stanza IDs
pub mod stanza_id;

/// XEP-0380: Explicit Message Encryption
pub mod eme;

/// XEP-0390: Entity Capabilities 2.0
pub mod ecaps2;