pontarius-xmpp/README.md

Welcome to Pontarius XMPP!

Pontarius XMPP is an active work in progress to build a Haskell XMPP client library that implements the capabilities of RFC 6120 ("XMPP CORE"), RFC 6121 ("XMPP IM"), and RFC 6122 ("XMPP ADDR"). Pontarius XMPP is part of the Pontarius project, an effort to produce free and open source, uncentralized, and privacy-aware software solutions.

Getting started

The latest release of Pontarius XMPP, as well as its module API pages, can always be found at the Pontarius XMPP Hackage page.

Note: Pontarius XMPP is still in its Alpha phase. Pontarius XMPP is not yet feature-complete, it may contain bugs, and its API may change between versions.

Note: You will need the ICU Unicode library and it's header files in order to be able to build Pontarius XMPP. On Debian, you will need to install the libicu-dev package. In Fedora, the package is called libicu-devel.

Note to GHC 7.0 users: You will need cabal-install, version 0.14.0 or higher, or the build will fail with an "unrecognized option: --disable-benchmarks" error. The versions 1.16.0 and higher might not build on your system; if so, install 0.14.0 with "cabal install cabal-install-0.14.0".

The first thing to do is to import the modules that we are going to use. We are also using the OverloadedStrings LANGUAGE pragma in order to be able to type Text values like strings.

{-# LANGUAGE OverloadedStrings #-}

import Network.Xmpp

import Control.Monad
import Data.Default
import System.Log.Logger

Pontarius XMPP supports hslogger logging. Start by enabling console logging.

updateGlobalLogger "Pontarius.Xmpp" $ setLevel DEBUG

When this is done, a Session object can be acquired by calling session. This object will be used for interacting with the library.

result <- session
             "example.com"
              (Just (\_ -> ( [scramSha1 "username" Nothing "password"])
                           , Nothing))
              def

The three parameters above are the XMPP server realm, a SASL handler (for authentication), and the session configuration settings (set to the default settings). session will perform the necessary DNS queries to find the address of the realm, connect, establish the XMPP stream, attempt to secure the stream with TLS, authenticate, establish a concurrent interface for interacting with the stream, and return the Session object.

The return type of session is IO (Either XmppFailure Session). As XmppFailure is an Control.Monad.Error instance, you can utilize the ErrorT monad transformer for error handling. A more simple way of doing it could be doing something like this:

sess <- case result of
            Right s -> return s
            Left e -> error $ "XmppFailure: " ++ (show e)

Next, let us set our status to Online.

sendPresence def sess

Here, def refers to the default Presence value, which is the same as Presence Nothing Nothing Nothing Nothing Available [].

Now, let's say that we want to receive all message stanzas, and echo the stanzas back to the recipient. This can be done like so:

forever $ do
    msg <- getMessage sess
    case answerMessage msg (messagePayload msg) of
        Just answer -> sendMessage answer sess
        Nothing -> putStrLn "Received message with no sender."

Additional XMPP threads can be created using dupSession and forkIO.

For a public domain example of a simple Pontarius XMPP (Cabal) project, refer to the examples/echoclient directory.

More information

Feel free to contact Jon Kristensen if you have any questions or comments.