You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
143 lines
3.2 KiB
143 lines
3.2 KiB
-- Copyright © 2010-2012 Jon Kristensen. See the LICENSE file in the |
|
-- Pontarius distribution for more details. |
|
|
|
{-# OPTIONS_HADDOCK hide #-} |
|
|
|
-- The stanza record types are generally pretty convenient to work with. |
|
-- However, due to the fact that an "IQ" can be both an "IQRequest" and an |
|
-- "IQResponse" we provide some helper functions in this module that work on |
|
-- both types. |
|
-- |
|
-- We also provide functions to create a new stanza ID generator, and to |
|
-- generate new IDs. |
|
|
|
module Network.XMPP.Stanza ( |
|
iqID, |
|
iqFrom, |
|
iqTo, |
|
iqLangTag, |
|
iqPayload, |
|
iqPayloadNamespace, |
|
iqRequestPayloadNamespace, |
|
iqResponsePayloadNamespace |
|
) where |
|
|
|
import Network.XMPP.Address |
|
import Network.XMPP.Types |
|
|
|
import Data.XML.Types (Element, elementName, nameNamespace) |
|
import Data.Text (unpack) |
|
|
|
|
|
-- | |
|
-- Returns the @StanzaID@ value of the @IQ@, if any. |
|
|
|
iqID :: IQ -> Maybe StanzaID |
|
|
|
iqID (Left req) = iqRequestID req |
|
iqID (Right res) = iqResponseID res |
|
|
|
|
|
-- TODO: Maybe? |
|
|
|
iqResponseID :: IQResponse -> Maybe StanzaID |
|
|
|
iqResponseID (Left err) = iqErrorID err |
|
iqResponseID (Right res) = iqResultID res |
|
|
|
|
|
-- | |
|
-- Returns the @From@ @JID@ value of the @IQ@, if any. |
|
|
|
iqFrom :: IQ -> Maybe From |
|
|
|
iqFrom (Left req) = iqRequestFrom req |
|
iqFrom (Right res) = iqResponseFrom res |
|
|
|
|
|
-- | |
|
-- Returns the @To@ @JID@ value of the @IQ@, if any. |
|
|
|
iqTo :: IQ -> Maybe To |
|
|
|
iqTo (Left req) = iqRequestTo req |
|
iqTo (Right res) = iqResponseTo res |
|
|
|
|
|
-- | |
|
-- Returns the @XMLLang@ value of the @IQ@, if any. |
|
|
|
iqLangTag :: IQ -> LangTag |
|
|
|
iqLangTag (Left req) = iqRequestLangTag req |
|
iqLangTag (Right res) = iqResponseLangTag res |
|
|
|
|
|
iqResponseLangTag :: IQResponse -> LangTag |
|
|
|
iqResponseLangTag (Left err) = iqErrorLangTag err |
|
iqResponseLangTag (Right res) = iqResultLangTag res |
|
|
|
|
|
iqResponseFrom :: IQResponse -> Maybe From |
|
|
|
iqResponseFrom (Left err) = iqErrorFrom err |
|
iqResponseFrom (Right res) = iqResultFrom res |
|
|
|
|
|
iqResponseTo :: IQResponse -> Maybe To |
|
|
|
iqResponseTo (Left err) = iqErrorTo err |
|
iqResponseTo (Right res) = iqResultTo res |
|
|
|
|
|
|
|
-- | |
|
-- Returns the @Element@ payload value of the @IQ@, if any. If the IQ in |
|
-- question is of the "request" type, use @iqRequestPayload@ instead. |
|
|
|
iqPayload :: IQ -> Maybe Element |
|
|
|
iqPayload (Left req) = Just (iqRequestPayload req) |
|
iqPayload (Right res) = iqResponsePayload res |
|
|
|
|
|
iqResponsePayload :: IQResponse -> Maybe Element |
|
|
|
iqResponsePayload (Left err) = iqErrorPayload err |
|
iqResponsePayload (Right res) = iqResultPayload res |
|
|
|
|
|
-- | |
|
-- Returns the namespace of the element of the @IQ@, if any. |
|
|
|
iqPayloadNamespace :: IQ -> Maybe String |
|
|
|
iqPayloadNamespace i = case iqPayload i of |
|
Nothing -> Nothing |
|
Just p -> case nameNamespace $ elementName p of |
|
Nothing -> Nothing |
|
Just n -> Just (unpack n) |
|
|
|
|
|
-- | |
|
-- Returns the namespace of the element of the @IQRequest@, if any. |
|
|
|
iqRequestPayloadNamespace :: IQRequest -> Maybe String |
|
|
|
iqRequestPayloadNamespace i = let p = iqRequestPayload i in |
|
case nameNamespace $ elementName p of |
|
Nothing -> Nothing |
|
Just n -> Just (unpack n) |
|
|
|
|
|
-- | |
|
-- Returns the namespace of the element of the @IQRequest@, if any. |
|
|
|
iqResponsePayloadNamespace :: IQResponse -> Maybe String |
|
|
|
iqResponsePayloadNamespace i = case iqResponsePayload i of |
|
Nothing -> Nothing |
|
Just p -> case nameNamespace $ elementName p of |
|
Nothing -> Nothing |
|
Just n -> Just (unpack n) |