mirror of
https://gitlab.com/xmpp-rs/xmpp-rs.git
synced 2024-06-18 05:35:57 +02:00
943 lines
29 KiB
Rust
943 lines
29 KiB
Rust
// Copyright (c) 2017, 2018 lumi <lumi@pew.im>
|
||
// Copyright (c) 2017, 2018, 2019 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
|
||
// Copyright (c) 2017, 2018, 2019 Maxime “pep” Buquet <pep@bouah.net>
|
||
// Copyright (c) 2017, 2018 Astro <astro@spaceboyz.net>
|
||
// Copyright (c) 2017 Bastien Orivel <eijebong@bananium.fr>
|
||
//
|
||
// 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/.
|
||
|
||
#![deny(missing_docs)]
|
||
|
||
//! Represents XMPP addresses, also known as JabberIDs (JIDs) for the [XMPP](https://xmpp.org/)
|
||
//! protocol. A [`Jid`] can have between one and three parts in the form `node@domain/resource`:
|
||
//! - the (optional) node part designates a specific account/service on a server, for example
|
||
//! `username@server.com`
|
||
//! - the domain part designates a server, for example `irc.jabberfr.org`
|
||
//! - the (optional) resource part designates a more specific client, such as a participant in a
|
||
//! groupchat (`jabberfr@chat.jabberfr.org/user`) or a specific client device associated with an
|
||
//! account (`user@example.com/dino`)
|
||
//!
|
||
//! The [`Jid`] enum can be one of two variants, containing a more specific type:
|
||
//! - [`BareJid`] (`Jid::Bare` variant): a JID without a resource
|
||
//! - [`FullJid`] (`Jid::Full` variant): a JID with a resource
|
||
//!
|
||
//! Jids as per the XMPP protocol only ever contain valid UTF-8. However, creating any form of Jid
|
||
//! can fail in one of the following cases:
|
||
//! - wrong syntax: creating a Jid with an empty (yet declared) node or resource part, such as
|
||
//! `@example.com` or `user@example.com/`
|
||
//! - stringprep error: some characters were invalid according to the stringprep algorithm, such as
|
||
//! mixing left-to-write and right-to-left characters
|
||
|
||
use core::num::NonZeroU16;
|
||
use std::fmt;
|
||
use std::str::FromStr;
|
||
|
||
#[cfg(feature = "serde")]
|
||
use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
|
||
|
||
#[cfg(feature = "quote")]
|
||
use proc_macro2::TokenStream;
|
||
#[cfg(feature = "quote")]
|
||
use quote::{quote, ToTokens};
|
||
|
||
mod error;
|
||
pub use crate::error::Error;
|
||
|
||
mod inner;
|
||
use inner::InnerJid;
|
||
|
||
mod parts;
|
||
pub use parts::{DomainPart, DomainRef, NodePart, NodeRef, ResourcePart, ResourceRef};
|
||
|
||
/// An enum representing a Jabber ID. It can be either a `FullJid` or a `BareJid`.
|
||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||
#[cfg_attr(feature = "serde", serde(untagged))]
|
||
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||
pub enum Jid {
|
||
/// Contains a [`BareJid`], without a resource part
|
||
Bare(BareJid),
|
||
|
||
/// Contains a [`FullJid`], with a resource part
|
||
Full(FullJid),
|
||
}
|
||
|
||
impl FromStr for Jid {
|
||
type Err = Error;
|
||
|
||
fn from_str(s: &str) -> Result<Jid, Error> {
|
||
Jid::new(s)
|
||
}
|
||
}
|
||
|
||
impl From<BareJid> for Jid {
|
||
fn from(bare_jid: BareJid) -> Jid {
|
||
Jid::Bare(bare_jid)
|
||
}
|
||
}
|
||
|
||
impl From<FullJid> for Jid {
|
||
fn from(full_jid: FullJid) -> Jid {
|
||
Jid::Full(full_jid)
|
||
}
|
||
}
|
||
|
||
impl fmt::Display for Jid {
|
||
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
|
||
match self {
|
||
Jid::Bare(bare) => bare.fmt(fmt),
|
||
Jid::Full(full) => full.fmt(fmt),
|
||
}
|
||
}
|
||
}
|
||
|
||
impl Jid {
|
||
/// Constructs a Jabber ID from a string. This is of the form
|
||
/// `node`@`domain`/`resource`, where node and resource parts are optional.
|
||
/// If you want a non-fallible version, use [`Jid::from_parts`] instead.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```
|
||
/// use jid::Jid;
|
||
/// # use jid::Error;
|
||
///
|
||
/// # fn main() -> Result<(), Error> {
|
||
/// let jid = Jid::new("node@domain/resource")?;
|
||
///
|
||
/// assert_eq!(jid.node().map(|x| x.as_str()), Some("node"));
|
||
/// assert_eq!(jid.domain().as_str(), "domain");
|
||
/// assert_eq!(jid.resource().map(|x| x.as_str()), Some("resource"));
|
||
/// # Ok(())
|
||
/// # }
|
||
/// ```
|
||
pub fn new(s: &str) -> Result<Jid, Error> {
|
||
let inner = InnerJid::new(s)?;
|
||
if inner.slash.is_some() {
|
||
Ok(Jid::Full(FullJid { inner }))
|
||
} else {
|
||
Ok(Jid::Bare(BareJid { inner }))
|
||
}
|
||
}
|
||
|
||
/// Returns the inner String of this JID.
|
||
pub fn into_inner(self) -> String {
|
||
match self {
|
||
Jid::Bare(BareJid { inner }) | Jid::Full(FullJid { inner }) => inner.normalized,
|
||
}
|
||
}
|
||
|
||
/// Build a [`Jid`] from typed parts. This method cannot fail because it uses parts that have
|
||
/// already been parsed and stringprepped into [`NodePart`], [`DomainPart`], and [`ResourcePart`].
|
||
///
|
||
/// This method allocates and does not consume the typed parts. To avoid
|
||
/// allocation if both `node` and `resource` are known to be `None` and
|
||
/// `domain` is owned, you can use `domain.into()`.
|
||
pub fn from_parts(
|
||
node: Option<&NodeRef>,
|
||
domain: &DomainRef,
|
||
resource: Option<&ResourceRef>,
|
||
) -> Jid {
|
||
if let Some(resource) = resource {
|
||
Jid::Full(FullJid::from_parts(node, domain, resource))
|
||
} else {
|
||
Jid::Bare(BareJid::from_parts(node, domain))
|
||
}
|
||
}
|
||
|
||
/// The optional node part of the JID as reference.
|
||
pub fn node(&self) -> Option<&NodeRef> {
|
||
match self {
|
||
Jid::Bare(BareJid { inner }) | Jid::Full(FullJid { inner }) => inner.node(),
|
||
}
|
||
}
|
||
|
||
/// The domain part of the JID as reference
|
||
pub fn domain(&self) -> &DomainRef {
|
||
match self {
|
||
Jid::Bare(BareJid { inner }) | Jid::Full(FullJid { inner }) => inner.domain(),
|
||
}
|
||
}
|
||
|
||
/// The optional resource of the Jabber ID. It is guaranteed to be present when the JID is
|
||
/// a Full variant, which you can check with [`Jid::is_full`].
|
||
pub fn resource(&self) -> Option<&ResourceRef> {
|
||
match self {
|
||
Jid::Bare(BareJid { inner }) | Jid::Full(FullJid { inner }) => inner.resource(),
|
||
}
|
||
}
|
||
|
||
/// Allocate a new [`BareJid`] from this JID, discarding the resource.
|
||
pub fn to_bare(&self) -> BareJid {
|
||
match self {
|
||
Jid::Full(jid) => jid.to_bare(),
|
||
Jid::Bare(jid) => jid.clone(),
|
||
}
|
||
}
|
||
|
||
/// Transforms this JID into a [`BareJid`], throwing away the resource.
|
||
pub fn into_bare(self) -> BareJid {
|
||
match self {
|
||
Jid::Full(jid) => jid.into_bare(),
|
||
Jid::Bare(jid) => jid,
|
||
}
|
||
}
|
||
|
||
/// Checks if the JID contains a [`FullJid`]
|
||
pub fn is_full(&self) -> bool {
|
||
match self {
|
||
Self::Full(_) => true,
|
||
Self::Bare(_) => false,
|
||
}
|
||
}
|
||
|
||
/// Checks if the JID contains a [`BareJid`]
|
||
pub fn is_bare(&self) -> bool {
|
||
!self.is_full()
|
||
}
|
||
|
||
/// Return a reference to the canonical string representation of the JID.
|
||
pub fn as_str(&self) -> &str {
|
||
match self {
|
||
Jid::Bare(BareJid { inner }) | Jid::Full(FullJid { inner }) => inner.as_str(),
|
||
}
|
||
}
|
||
}
|
||
|
||
impl TryFrom<Jid> for FullJid {
|
||
type Error = Error;
|
||
|
||
fn try_from(jid: Jid) -> Result<Self, Self::Error> {
|
||
match jid {
|
||
Jid::Full(full) => Ok(full),
|
||
Jid::Bare(_) => Err(Error::ResourceMissingInFullJid),
|
||
}
|
||
}
|
||
}
|
||
|
||
impl PartialEq<Jid> for FullJid {
|
||
fn eq(&self, other: &Jid) -> bool {
|
||
match other {
|
||
Jid::Full(full) => self == full,
|
||
Jid::Bare(_) => false,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl PartialEq<Jid> for BareJid {
|
||
fn eq(&self, other: &Jid) -> bool {
|
||
match other {
|
||
Jid::Full(_) => false,
|
||
Jid::Bare(bare) => self == bare,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl PartialEq<FullJid> for Jid {
|
||
fn eq(&self, other: &FullJid) -> bool {
|
||
match self {
|
||
Jid::Full(full) => full == other,
|
||
Jid::Bare(_) => false,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl PartialEq<BareJid> for Jid {
|
||
fn eq(&self, other: &BareJid) -> bool {
|
||
match self {
|
||
Jid::Full(_) => false,
|
||
Jid::Bare(bare) => bare == other,
|
||
}
|
||
}
|
||
}
|
||
|
||
/// A struct representing a full Jabber ID, with a resource part.
|
||
///
|
||
/// A full JID is composed of 3 components, of which only the node is optional:
|
||
///
|
||
/// - the (optional) node part is the part before the (optional) `@`.
|
||
/// - the domain part is the mandatory part between the (optional) `@` and before the `/`.
|
||
/// - the resource part after the `/`.
|
||
///
|
||
/// Unlike a [`BareJid`], it always contains a resource, and should only be used when you are
|
||
/// certain there is no case where a resource can be missing. Otherwise, use a [`Jid`] or
|
||
/// [`BareJid`].
|
||
#[derive(Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||
pub struct FullJid {
|
||
inner: InnerJid,
|
||
}
|
||
|
||
/// A struct representing a bare Jabber ID, without a resource part.
|
||
///
|
||
/// A bare JID is composed of 2 components, of which only the node is optional:
|
||
/// - the (optional) node part is the part before the (optional) `@`.
|
||
/// - the domain part is the mandatory part between the (optional) `@` and before the `/`.
|
||
///
|
||
/// Unlike a [`FullJid`], it can’t contain a resource, and should only be used when you are certain
|
||
/// there is no case where a resource can be set. Otherwise, use a [`Jid`] or [`FullJid`].
|
||
#[derive(Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
||
pub struct BareJid {
|
||
inner: InnerJid,
|
||
}
|
||
|
||
impl fmt::Debug for FullJid {
|
||
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
|
||
fmt.debug_tuple("FullJid").field(&self.inner).finish()
|
||
}
|
||
}
|
||
|
||
impl fmt::Debug for BareJid {
|
||
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
|
||
fmt.debug_tuple("BareJid").field(&self.inner).finish()
|
||
}
|
||
}
|
||
|
||
impl fmt::Display for FullJid {
|
||
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
|
||
fmt.write_str(&self.inner.normalized)
|
||
}
|
||
}
|
||
|
||
impl fmt::Display for BareJid {
|
||
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
|
||
fmt.write_str(&self.inner.normalized)
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "serde")]
|
||
impl Serialize for FullJid {
|
||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||
where
|
||
S: Serializer,
|
||
{
|
||
serializer.serialize_str(&self.inner.normalized)
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "serde")]
|
||
impl Serialize for BareJid {
|
||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||
where
|
||
S: Serializer,
|
||
{
|
||
serializer.serialize_str(&self.inner.normalized)
|
||
}
|
||
}
|
||
|
||
impl FromStr for FullJid {
|
||
type Err = Error;
|
||
|
||
fn from_str(s: &str) -> Result<FullJid, Error> {
|
||
FullJid::new(s)
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "serde")]
|
||
impl<'de> Deserialize<'de> for FullJid {
|
||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||
where
|
||
D: Deserializer<'de>,
|
||
{
|
||
let s = String::deserialize(deserializer)?;
|
||
FullJid::from_str(&s).map_err(de::Error::custom)
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "serde")]
|
||
impl<'de> Deserialize<'de> for BareJid {
|
||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||
where
|
||
D: Deserializer<'de>,
|
||
{
|
||
let s = String::deserialize(deserializer)?;
|
||
BareJid::from_str(&s).map_err(de::Error::custom)
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "quote")]
|
||
impl ToTokens for Jid {
|
||
fn to_tokens(&self, tokens: &mut TokenStream) {
|
||
tokens.extend(match self {
|
||
Jid::Full(full) => quote! { Jid::Full(#full) },
|
||
Jid::Bare(bare) => quote! { Jid::Bare(#bare) },
|
||
});
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "quote")]
|
||
impl ToTokens for FullJid {
|
||
fn to_tokens(&self, tokens: &mut TokenStream) {
|
||
let inner = &self.inner.normalized;
|
||
let t = quote! { FullJid::new(#inner).unwrap() };
|
||
tokens.extend(t);
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "quote")]
|
||
impl ToTokens for BareJid {
|
||
fn to_tokens(&self, tokens: &mut TokenStream) {
|
||
let inner = &self.inner.normalized;
|
||
let t = quote! { BareJid::new(#inner).unwrap() };
|
||
tokens.extend(t);
|
||
}
|
||
}
|
||
|
||
impl FullJid {
|
||
/// Constructs a full Jabber ID containing all three components. This is of the form
|
||
/// `node@domain/resource`, where node part is optional.
|
||
/// If you want a non-fallible version, use [`FullJid::from_parts`] instead.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```
|
||
/// use jid::FullJid;
|
||
/// # use jid::Error;
|
||
///
|
||
/// # fn main() -> Result<(), Error> {
|
||
/// let jid = FullJid::new("node@domain/resource")?;
|
||
///
|
||
/// assert_eq!(jid.node().map(|x| x.as_str()), Some("node"));
|
||
/// assert_eq!(jid.domain().as_str(), "domain");
|
||
/// assert_eq!(jid.resource().as_str(), "resource");
|
||
/// # Ok(())
|
||
/// # }
|
||
/// ```
|
||
pub fn new(s: &str) -> Result<FullJid, Error> {
|
||
let inner = InnerJid::new(s)?;
|
||
if inner.slash.is_some() {
|
||
Ok(FullJid { inner })
|
||
} else {
|
||
Err(Error::ResourceMissingInFullJid)
|
||
}
|
||
}
|
||
|
||
/// Returns the inner String of this JID.
|
||
pub fn into_inner(self) -> String {
|
||
self.inner.normalized
|
||
}
|
||
|
||
/// Build a [`FullJid`] from typed parts. This method cannot fail because it uses parts that have
|
||
/// already been parsed and stringprepped into [`NodePart`], [`DomainPart`], and [`ResourcePart`].
|
||
/// This method allocates and does not consume the typed parts.
|
||
pub fn from_parts(
|
||
node: Option<&NodeRef>,
|
||
domain: &DomainRef,
|
||
resource: &ResourceRef,
|
||
) -> FullJid {
|
||
let (at, slash, normalized) = if let Some(node) = node {
|
||
// Parts are never empty so len > 0 for NonZeroU16::new is always Some
|
||
(
|
||
NonZeroU16::new(node.len() as u16),
|
||
NonZeroU16::new((node.len() + 1 + domain.len()) as u16),
|
||
format!(
|
||
"{}@{}/{}",
|
||
node.as_str(),
|
||
domain.as_str(),
|
||
resource.as_str()
|
||
),
|
||
)
|
||
} else {
|
||
(
|
||
None,
|
||
NonZeroU16::new(domain.len() as u16),
|
||
format!("{}/{}", domain.as_str(), resource.as_str()),
|
||
)
|
||
};
|
||
|
||
let inner = InnerJid {
|
||
normalized,
|
||
at,
|
||
slash,
|
||
};
|
||
|
||
FullJid { inner }
|
||
}
|
||
|
||
/// The optional node part of the JID as reference.
|
||
pub fn node(&self) -> Option<&NodeRef> {
|
||
self.inner.node()
|
||
}
|
||
|
||
/// The domain part of the JID as reference
|
||
pub fn domain(&self) -> &DomainRef {
|
||
self.inner.domain()
|
||
}
|
||
|
||
/// The optional resource of the Jabber ID. Since this is a full JID it is always present.
|
||
pub fn resource(&self) -> &ResourceRef {
|
||
self.inner.resource().unwrap()
|
||
}
|
||
|
||
/// Allocate a new [`BareJid`] from this full JID, discarding the resource.
|
||
pub fn to_bare(&self) -> BareJid {
|
||
let slash = self.inner.slash.unwrap().get() as usize;
|
||
let normalized = self.inner.normalized[..slash].to_string();
|
||
let inner = InnerJid {
|
||
normalized,
|
||
at: self.inner.at,
|
||
slash: None,
|
||
};
|
||
BareJid { inner }
|
||
}
|
||
|
||
/// Transforms this full JID into a [`BareJid`], discarding the resource.
|
||
pub fn into_bare(mut self) -> BareJid {
|
||
let slash = self.inner.slash.unwrap().get() as usize;
|
||
self.inner.normalized.truncate(slash);
|
||
self.inner.normalized.shrink_to_fit();
|
||
self.inner.slash = None;
|
||
BareJid { inner: self.inner }
|
||
}
|
||
|
||
/// Return a reference to the canonical string representation of the JID.
|
||
pub fn as_str(&self) -> &str {
|
||
self.inner.as_str()
|
||
}
|
||
}
|
||
|
||
impl FromStr for BareJid {
|
||
type Err = Error;
|
||
|
||
fn from_str(s: &str) -> Result<BareJid, Error> {
|
||
BareJid::new(s)
|
||
}
|
||
}
|
||
|
||
impl BareJid {
|
||
/// Constructs a bare Jabber ID, containing two components. This is of the form
|
||
/// `node`@`domain`, where node part is optional.
|
||
/// If you want a non-fallible version, use [`BareJid::from_parts`] instead.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```
|
||
/// use jid::BareJid;
|
||
/// # use jid::Error;
|
||
///
|
||
/// # fn main() -> Result<(), Error> {
|
||
/// let jid = BareJid::new("node@domain")?;
|
||
///
|
||
/// assert_eq!(jid.node().map(|x| x.as_str()), Some("node"));
|
||
/// assert_eq!(jid.domain().as_str(), "domain");
|
||
/// # Ok(())
|
||
/// # }
|
||
/// ```
|
||
pub fn new(s: &str) -> Result<BareJid, Error> {
|
||
let inner = InnerJid::new(s)?;
|
||
if inner.slash.is_none() {
|
||
Ok(BareJid { inner })
|
||
} else {
|
||
Err(Error::ResourceInBareJid)
|
||
}
|
||
}
|
||
|
||
/// Returns the inner String of this JID.
|
||
pub fn into_inner(self) -> String {
|
||
self.inner.normalized
|
||
}
|
||
|
||
/// Build a [`BareJid`] from typed parts. This method cannot fail because it uses parts that have
|
||
/// already been parsed and stringprepped into [`NodePart`] and [`DomainPart`].
|
||
///
|
||
/// This method allocates and does not consume the typed parts. To avoid
|
||
/// allocation if `node` is known to be `None` and `domain` is owned, you
|
||
/// can use `domain.into()`.
|
||
pub fn from_parts(node: Option<&NodeRef>, domain: &DomainRef) -> BareJid {
|
||
let (at, normalized) = if let Some(node) = node {
|
||
// Parts are never empty so len > 0 for NonZeroU16::new is always Some
|
||
(
|
||
NonZeroU16::new(node.len() as u16),
|
||
format!("{}@{}", node.as_str(), domain.as_str()),
|
||
)
|
||
} else {
|
||
(None, domain.to_string())
|
||
};
|
||
|
||
let inner = InnerJid {
|
||
normalized,
|
||
at,
|
||
slash: None,
|
||
};
|
||
|
||
BareJid { inner }
|
||
}
|
||
|
||
/// The optional node part of the JID as reference.
|
||
pub fn node(&self) -> Option<&NodeRef> {
|
||
self.inner.node()
|
||
}
|
||
|
||
/// The domain part of the JID as reference
|
||
pub fn domain(&self) -> &DomainRef {
|
||
self.inner.domain()
|
||
}
|
||
|
||
/// Constructs a [`BareJid`] from the bare JID, by specifying a [`ResourcePart`].
|
||
/// If you'd like to specify a stringy resource, use [`BareJid::with_resource_str`] instead.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```
|
||
/// use jid::{BareJid, ResourcePart};
|
||
///
|
||
/// let resource = ResourcePart::new("resource").unwrap();
|
||
/// let bare = BareJid::new("node@domain").unwrap();
|
||
/// let full = bare.with_resource(&resource);
|
||
///
|
||
/// assert_eq!(full.node().map(|x| x.as_str()), Some("node"));
|
||
/// assert_eq!(full.domain().as_str(), "domain");
|
||
/// assert_eq!(full.resource().as_str(), "resource");
|
||
/// ```
|
||
pub fn with_resource(&self, resource: &ResourceRef) -> FullJid {
|
||
let slash = NonZeroU16::new(self.inner.normalized.len() as u16);
|
||
let normalized = format!("{}/{resource}", self.inner.normalized);
|
||
let inner = InnerJid {
|
||
normalized,
|
||
at: self.inner.at,
|
||
slash,
|
||
};
|
||
|
||
FullJid { inner }
|
||
}
|
||
|
||
/// Constructs a [`FullJid`] from the bare JID, by specifying a stringy `resource`.
|
||
/// If your resource has already been parsed into a [`ResourcePart`], use [`BareJid::with_resource`].
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```
|
||
/// use jid::BareJid;
|
||
///
|
||
/// let bare = BareJid::new("node@domain").unwrap();
|
||
/// let full = bare.with_resource_str("resource").unwrap();
|
||
///
|
||
/// assert_eq!(full.node().map(|x| x.as_str()), Some("node"));
|
||
/// assert_eq!(full.domain().as_str(), "domain");
|
||
/// assert_eq!(full.resource().as_str(), "resource");
|
||
/// ```
|
||
pub fn with_resource_str(&self, resource: &str) -> Result<FullJid, Error> {
|
||
let resource = ResourcePart::new(resource)?;
|
||
Ok(self.with_resource(&resource))
|
||
}
|
||
|
||
/// Return a reference to the canonical string representation of the JID.
|
||
pub fn as_str(&self) -> &str {
|
||
self.inner.as_str()
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
use minidom::{IntoAttributeValue, Node};
|
||
|
||
#[cfg(feature = "minidom")]
|
||
impl IntoAttributeValue for Jid {
|
||
fn into_attribute_value(self) -> Option<String> {
|
||
Some(self.to_string())
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
impl From<Jid> for Node {
|
||
fn from(jid: Jid) -> Node {
|
||
Node::Text(jid.to_string())
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
impl IntoAttributeValue for FullJid {
|
||
fn into_attribute_value(self) -> Option<String> {
|
||
Some(self.to_string())
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
impl From<FullJid> for Node {
|
||
fn from(jid: FullJid) -> Node {
|
||
Node::Text(jid.to_string())
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
impl IntoAttributeValue for BareJid {
|
||
fn into_attribute_value(self) -> Option<String> {
|
||
Some(self.to_string())
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
impl From<BareJid> for Node {
|
||
fn from(jid: BareJid) -> Node {
|
||
Node::Text(jid.to_string())
|
||
}
|
||
}
|
||
|
||
#[cfg(test)]
|
||
mod tests {
|
||
use super::*;
|
||
|
||
use std::collections::HashMap;
|
||
|
||
macro_rules! assert_size (
|
||
($t:ty, $sz:expr) => (
|
||
assert_eq!(::std::mem::size_of::<$t>(), $sz);
|
||
);
|
||
);
|
||
|
||
#[cfg(target_pointer_width = "32")]
|
||
#[test]
|
||
fn test_size() {
|
||
assert_size!(BareJid, 16);
|
||
assert_size!(FullJid, 16);
|
||
assert_size!(Jid, 20);
|
||
}
|
||
|
||
#[cfg(target_pointer_width = "64")]
|
||
#[test]
|
||
fn test_size() {
|
||
assert_size!(BareJid, 32);
|
||
assert_size!(FullJid, 32);
|
||
assert_size!(Jid, 40);
|
||
}
|
||
|
||
#[test]
|
||
fn can_parse_full_jids() {
|
||
assert_eq!(
|
||
FullJid::from_str("a@b.c/d"),
|
||
Ok(FullJid::new("a@b.c/d").unwrap())
|
||
);
|
||
assert_eq!(
|
||
FullJid::from_str("b.c/d"),
|
||
Ok(FullJid::new("b.c/d").unwrap())
|
||
);
|
||
|
||
assert_eq!(
|
||
FullJid::from_str("a@b.c"),
|
||
Err(Error::ResourceMissingInFullJid)
|
||
);
|
||
assert_eq!(
|
||
FullJid::from_str("b.c"),
|
||
Err(Error::ResourceMissingInFullJid)
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn can_parse_bare_jids() {
|
||
assert_eq!(
|
||
BareJid::from_str("a@b.c"),
|
||
Ok(BareJid::new("a@b.c").unwrap())
|
||
);
|
||
assert_eq!(BareJid::from_str("b.c"), Ok(BareJid::new("b.c").unwrap()));
|
||
}
|
||
|
||
#[test]
|
||
fn can_parse_jids() {
|
||
let full = FullJid::from_str("a@b.c/d").unwrap();
|
||
let bare = BareJid::from_str("e@f.g").unwrap();
|
||
|
||
assert_eq!(Jid::from_str("a@b.c/d"), Ok(Jid::Full(full)));
|
||
assert_eq!(Jid::from_str("e@f.g"), Ok(Jid::Bare(bare)));
|
||
}
|
||
|
||
#[test]
|
||
fn full_to_bare_jid() {
|
||
let bare: BareJid = FullJid::new("a@b.c/d").unwrap().to_bare();
|
||
assert_eq!(bare, BareJid::new("a@b.c").unwrap());
|
||
}
|
||
|
||
#[test]
|
||
fn bare_to_full_jid_str() {
|
||
assert_eq!(
|
||
BareJid::new("a@b.c")
|
||
.unwrap()
|
||
.with_resource_str("d")
|
||
.unwrap(),
|
||
FullJid::new("a@b.c/d").unwrap()
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn bare_to_full_jid() {
|
||
assert_eq!(
|
||
BareJid::new("a@b.c")
|
||
.unwrap()
|
||
.with_resource(&ResourcePart::new("d").unwrap()),
|
||
FullJid::new("a@b.c/d").unwrap()
|
||
)
|
||
}
|
||
|
||
#[test]
|
||
fn node_from_jid() {
|
||
let jid = Jid::new("a@b.c/d").unwrap();
|
||
|
||
assert_eq!(jid.node().map(|x| x.as_str()), Some("a"),);
|
||
}
|
||
|
||
#[test]
|
||
fn domain_from_jid() {
|
||
let jid = Jid::new("a@b.c").unwrap();
|
||
|
||
assert_eq!(jid.domain().as_str(), "b.c");
|
||
}
|
||
|
||
#[test]
|
||
fn resource_from_jid() {
|
||
let jid = Jid::new("a@b.c/d").unwrap();
|
||
|
||
assert_eq!(jid.resource().map(|x| x.as_str()), Some("d"),);
|
||
}
|
||
|
||
#[test]
|
||
fn jid_to_full_bare() {
|
||
let full = FullJid::new("a@b.c/d").unwrap();
|
||
let bare = BareJid::new("a@b.c").unwrap();
|
||
|
||
assert_eq!(FullJid::try_from(Jid::Full(full.clone())), Ok(full.clone()));
|
||
assert_eq!(
|
||
FullJid::try_from(Jid::Bare(bare.clone())),
|
||
Err(Error::ResourceMissingInFullJid),
|
||
);
|
||
assert_eq!(Jid::Bare(full.clone().to_bare()), bare.clone());
|
||
assert_eq!(Jid::Bare(bare.clone()), bare);
|
||
}
|
||
|
||
#[test]
|
||
fn serialise() {
|
||
assert_eq!(FullJid::new("a@b/c").unwrap().to_string(), "a@b/c");
|
||
assert_eq!(BareJid::new("a@b").unwrap().to_string(), "a@b");
|
||
}
|
||
|
||
#[test]
|
||
fn hash() {
|
||
let _map: HashMap<Jid, String> = HashMap::new();
|
||
}
|
||
|
||
#[test]
|
||
fn invalid_jids() {
|
||
assert_eq!(BareJid::from_str(""), Err(Error::DomainEmpty));
|
||
assert_eq!(BareJid::from_str("/c"), Err(Error::DomainEmpty));
|
||
assert_eq!(BareJid::from_str("a@/c"), Err(Error::DomainEmpty));
|
||
assert_eq!(BareJid::from_str("@b"), Err(Error::NodeEmpty));
|
||
assert_eq!(BareJid::from_str("b/"), Err(Error::ResourceEmpty));
|
||
|
||
assert_eq!(FullJid::from_str(""), Err(Error::DomainEmpty));
|
||
assert_eq!(FullJid::from_str("/c"), Err(Error::DomainEmpty));
|
||
assert_eq!(FullJid::from_str("a@/c"), Err(Error::DomainEmpty));
|
||
assert_eq!(FullJid::from_str("@b"), Err(Error::NodeEmpty));
|
||
assert_eq!(FullJid::from_str("b/"), Err(Error::ResourceEmpty));
|
||
assert_eq!(
|
||
FullJid::from_str("a@b"),
|
||
Err(Error::ResourceMissingInFullJid)
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn display_jids() {
|
||
assert_eq!(FullJid::new("a@b/c").unwrap().to_string(), "a@b/c");
|
||
assert_eq!(BareJid::new("a@b").unwrap().to_string(), "a@b");
|
||
assert_eq!(
|
||
Jid::Full(FullJid::new("a@b/c").unwrap()).to_string(),
|
||
"a@b/c"
|
||
);
|
||
assert_eq!(Jid::Bare(BareJid::new("a@b").unwrap()).to_string(), "a@b");
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
#[test]
|
||
fn minidom() {
|
||
let elem: minidom::Element = "<message xmlns='ns1' from='a@b/c'/>".parse().unwrap();
|
||
let to: Jid = elem.attr("from").unwrap().parse().unwrap();
|
||
assert_eq!(to, Jid::Full(FullJid::new("a@b/c").unwrap()));
|
||
|
||
let elem: minidom::Element = "<message xmlns='ns1' from='a@b'/>".parse().unwrap();
|
||
let to: Jid = elem.attr("from").unwrap().parse().unwrap();
|
||
assert_eq!(to, Jid::Bare(BareJid::new("a@b").unwrap()));
|
||
|
||
let elem: minidom::Element = "<message xmlns='ns1' from='a@b/c'/>".parse().unwrap();
|
||
let to: FullJid = elem.attr("from").unwrap().parse().unwrap();
|
||
assert_eq!(to, FullJid::new("a@b/c").unwrap());
|
||
|
||
let elem: minidom::Element = "<message xmlns='ns1' from='a@b'/>".parse().unwrap();
|
||
let to: BareJid = elem.attr("from").unwrap().parse().unwrap();
|
||
assert_eq!(to, BareJid::new("a@b").unwrap());
|
||
}
|
||
|
||
#[cfg(feature = "minidom")]
|
||
#[test]
|
||
fn minidom_into_attr() {
|
||
let full = FullJid::new("a@b/c").unwrap();
|
||
let elem = minidom::Element::builder("message", "jabber:client")
|
||
.attr("from", full.clone())
|
||
.build();
|
||
assert_eq!(elem.attr("from"), Some(full.to_string().as_str()));
|
||
|
||
let bare = BareJid::new("a@b").unwrap();
|
||
let elem = minidom::Element::builder("message", "jabber:client")
|
||
.attr("from", bare.clone())
|
||
.build();
|
||
assert_eq!(elem.attr("from"), Some(bare.to_string().as_str()));
|
||
|
||
let jid = Jid::Bare(bare.clone());
|
||
let _elem = minidom::Element::builder("message", "jabber:client")
|
||
.attr("from", jid)
|
||
.build();
|
||
assert_eq!(elem.attr("from"), Some(bare.to_string().as_str()));
|
||
}
|
||
|
||
#[test]
|
||
fn stringprep() {
|
||
let full = FullJid::from_str("Test@☃.coM/Test™").unwrap();
|
||
let equiv = FullJid::new("test@☃.com/TestTM").unwrap();
|
||
assert_eq!(full, equiv);
|
||
}
|
||
|
||
#[test]
|
||
fn invalid_stringprep() {
|
||
FullJid::from_str("a@b/🎉").unwrap_err();
|
||
}
|
||
|
||
#[test]
|
||
fn jid_from_parts() {
|
||
let node = NodePart::new("node").unwrap();
|
||
let domain = DomainPart::new("domain").unwrap();
|
||
let resource = ResourcePart::new("resource").unwrap();
|
||
|
||
let jid = Jid::from_parts(Some(&node), &domain, Some(&resource));
|
||
assert_eq!(jid, Jid::new("node@domain/resource").unwrap());
|
||
|
||
let barejid = BareJid::from_parts(Some(&node), &domain);
|
||
assert_eq!(barejid, BareJid::new("node@domain").unwrap());
|
||
|
||
let fulljid = FullJid::from_parts(Some(&node), &domain, &resource);
|
||
assert_eq!(fulljid, FullJid::new("node@domain/resource").unwrap());
|
||
}
|
||
|
||
#[test]
|
||
#[cfg(feature = "serde")]
|
||
fn jid_ser_de() {
|
||
let jid: Jid = Jid::new("node@domain").unwrap();
|
||
serde_test::assert_tokens(&jid, &[serde_test::Token::Str("node@domain")]);
|
||
|
||
let jid: Jid = Jid::new("node@domain/resource").unwrap();
|
||
serde_test::assert_tokens(&jid, &[serde_test::Token::Str("node@domain/resource")]);
|
||
|
||
let jid: BareJid = BareJid::new("node@domain").unwrap();
|
||
serde_test::assert_tokens(&jid, &[serde_test::Token::Str("node@domain")]);
|
||
|
||
let jid: FullJid = FullJid::new("node@domain/resource").unwrap();
|
||
serde_test::assert_tokens(&jid, &[serde_test::Token::Str("node@domain/resource")]);
|
||
}
|
||
|
||
#[test]
|
||
fn jid_into_parts_and_from_parts() {
|
||
let node = NodePart::new("node").unwrap();
|
||
let domain = DomainPart::new("domain").unwrap();
|
||
|
||
let jid1 = domain.with_node(&node);
|
||
let jid2 = node.with_domain(&domain);
|
||
let jid3 = BareJid::new("node@domain").unwrap();
|
||
assert_eq!(jid1, jid2);
|
||
assert_eq!(jid2, jid3);
|
||
}
|
||
}
|