xmpp-rs/src/component.rs

use xml;
use jid::Jid;
use transport::{Transport, PlainTransport};
use error::Error;
use ns;
use plugin::{Plugin, PluginInit, PluginProxyBinding};
use event::{Dispatcher, ReceiveElement};
use connection::{Connection, Component2S};
use sha_1::{Sha1, Digest};

use minidom::Element;

use xml::reader::XmlEvent as ReaderEvent;

use std::fmt::Write;
use std::sync::{Mutex, Arc};

use std::collections::HashMap;

use std::any::TypeId;

/// A builder for `Component`s.
pub struct ComponentBuilder {
    jid: Jid,
    secret: String,
    host: Option<String>,
    port: u16,
}

impl ComponentBuilder {
    /// Creates a new builder for an XMPP component that will connect to `jid` with default parameters.
    pub fn new(jid: Jid) -> ComponentBuilder {
        ComponentBuilder {
            jid: jid,
            secret: "".to_owned(),
            host: None,
            port: 5347,
        }
    }

    /// Sets the host to connect to.
    pub fn host(mut self, host: String) -> ComponentBuilder {
        self.host = Some(host);
        self
    }

    /// Sets the port to connect to.
    pub fn port(mut self, port: u16) -> ComponentBuilder {
        self.port = port;
        self
    }

    /// Sets the password to use.
    pub fn password<P: Into<String>>(mut self, password: P) -> ComponentBuilder {
        self.secret = password.into();
        self
    }

    /// Connects to the server and returns a `Component` when succesful.
    pub fn connect(self) -> Result<Component, Error> {
        let host = &self.host.unwrap_or(self.jid.domain.clone());
        let mut transport = PlainTransport::connect(host, self.port)?;
        Component2S::init(&mut transport, &self.jid.domain, "stream_opening")?;
        let dispatcher = Arc::new(Mutex::new(Dispatcher::new()));
        let transport = Arc::new(Mutex::new(transport));
        let mut component = Component {
            jid: self.jid,
            transport: transport,
            plugins: HashMap::new(),
            binding: PluginProxyBinding::new(dispatcher.clone()),
            dispatcher: dispatcher,
        };
        component.connect(self.secret)?;
        Ok(component)
    }
}

/// An XMPP component.
pub struct Component {
    jid: Jid,
    transport: Arc<Mutex<PlainTransport>>,
    plugins: HashMap<TypeId, Arc<Box<Plugin>>>,
    binding: PluginProxyBinding,
    dispatcher: Arc<Mutex<Dispatcher>>,
}

impl Component {
    /// Returns a reference to the `Jid` associated with this `Component`.
    pub fn jid(&self) -> &Jid {
        &self.jid
    }

    /// Registers a plugin.
    pub fn register_plugin<P: Plugin + PluginInit + 'static>(&mut self, mut plugin: P) {
        let binding = self.binding.clone();
        plugin.bind(binding);
        let p = Arc::new(Box::new(plugin) as Box<Plugin>);
        {
            let mut disp = self.dispatcher.lock().unwrap();
            P::init(&mut disp, p.clone());
        }
        if self.plugins.insert(TypeId::of::<P>(), p).is_some() {
            panic!("registering a plugin that's already registered");
        }
    }

    /// Returns the plugin given by the type parameter, if it exists, else panics.
    pub fn plugin<P: Plugin>(&self) -> &P {
        self.plugins.get(&TypeId::of::<P>())
                    .expect("the requested plugin was not registered")
                    .as_any()
                    .downcast_ref::<P>()
                    .expect("plugin downcast failure (should not happen!!)")
    }

    /// Returns the next event and flush the send queue.
    pub fn main(&mut self) -> Result<(), Error> {
        self.dispatcher.lock().unwrap().flush_all();
        loop {
            let elem = self.read_element()?;
            {
                let mut disp = self.dispatcher.lock().unwrap();
                disp.dispatch(ReceiveElement(elem));
                disp.flush_all();
            }
        }
    }

    fn read_element(&self) -> Result<Element, Error> {
        self.transport.lock().unwrap().read_element()
    }

    fn write_element(&self, elem: &Element) -> Result<(), Error> {
        self.transport.lock().unwrap().write_element(elem)
    }

    fn read_event(&self) -> Result<xml::reader::XmlEvent, Error> {
        self.transport.lock().unwrap().read_event()
    }

    fn connect(&mut self, secret: String) -> Result<(), Error> {
        let mut sid = String::new();
        loop {
            let e = self.read_event()?;
            match e {
                ReaderEvent::StartElement { attributes, .. } => {
                    for attribute in attributes {
                        if attribute.name.namespace == None && attribute.name.local_name == "id" {
                            sid = attribute.value;
                        }
                    }
                    break;
                },
                _ => (),
            }
        }
        let concatenated = format!("{}{}", sid, secret);
        let mut hasher = Sha1::default();
        hasher.input(concatenated.as_bytes());
        let mut handshake = String::new();
        for byte in hasher.result() {
            write!(handshake, "{:02x}", byte)?;
        }
        let mut elem = Element::builder("handshake")
                               .ns(ns::COMPONENT_ACCEPT)
                               .build();
        elem.append_text_node(handshake);
        self.write_element(&elem)?;
        loop {
            let n = self.read_element()?;
            if n.is("handshake", ns::COMPONENT_ACCEPT) {
                return Ok(());
            }
        }
    }
}