pontarius-xpmn (empty) → 0.0.1.0
raw patch · 7 files changed
+1798/−0 lines, 7 filesdep +basedep +containersdep +pontarius-xmppsetup-changed
Dependencies added: base, containers, pontarius-xmpp, random, text, xml-types
Files
- Examples/TestDevice.hs +200/−0
- Media/XPMN/DeviceServer.hs +820/−0
- README +22/−0
- Setup.hs +3/−0
- agpl.txt +661/−0
- install.sh +5/−0
- pontarius-xpmn.cabal +87/−0
+ Examples/TestDevice.hs view
@@ -0,0 +1,200 @@+{-++This file (TestDevice.hs) is an example of how to use Pontarius XPMN. The+contents of this file may be used freely, as if it is in the public domain.++-}++import Network.XMPP+import Media.XPMN.DeviceServer++import Control.Concurrent (forkIO, threadDelay)+import Control.Concurrent.Chan (Chan, newChan, readChan, writeChan)+import Data.Maybe+import Data.XML.Types+import qualified Data.Text as DT+import System.Random++import qualified Data.Map as DM++data State = State { deviceServer :: DeviceServer+ , stateNumbers :: [(String, Integer)]+ , pingpongVar :: SimpleVariable Pingpong+ , numbersVar :: ComplexVariable Integer+ , stateStd :: StdGen+ , stateQueries :: [Query Integer] }++data Pingpong = Ping | Pong++instance XMLable Pingpong where+ toXML Ping = [NodeElement (Element (Name (DT.pack "ping") Nothing Nothing) (DM.fromList []) [])]+ toXML Pong = [NodeElement (Element (Name (DT.pack "pong") Nothing Nothing) (DM.fromList []) [])]+ fromXML [NodeElement (Element { elementName = n })] | nameLocalName n == DT.pack "ping" = Ping+ fromXML [NodeElement (Element { elementName = n })] | nameLocalName n == DT.pack "pong" = Pong++data InternalEvent = IED DeviceInEvent | IEP Bool deriving (Show)++host = "test.pontarius.org"+user = "sprint3-xpmn"+server = "test.pontarius.org"+port = 5222+resource = "pontarius"+password = ""++main :: IO ()+main =+ do -- Connect the XMPP account+ deviceServer <- start host port user password resource ["pingpong", "numbers"] ["even-numbers"]+ s <- (createSimpleVar deviceServer) "pingpong" Ping []+ ids <- mapM (\ _ -> getID) [0..9]+ let numbers = zip ids (reverse [0..9])+ let com = complexVariable "numbers" numbers []+ c <- newChan+ forkIO $ lolz (inEvents deviceServer) c+ stdGen <- getStdGen+ forkIO $ loop (State { deviceServer = deviceServer+ , pingpongVar = s+ , numbersVar = com+ , stateNumbers = numbers+ , stateStd = stdGen+ , stateQueries = [] }) c+ forkIO $ pingpong c+ return ()+ where+ loop :: State -> Chan InternalEvent -> IO ()+ loop s c =+ do e <- readChan c+ putStrLn $ "DeviceTest: Got InternalEvent: " ++ (show e)+ s' <- processEvent s e+ loop s' c+ + processEvent :: State -> InternalEvent -> IO State+ + processEvent s (IED DIEOnline) = do+ putStrLn "We are online!"+ return s+ + processEvent s (IED (DIEIncomingSimpleVariableGet j "pingpong")) = do+ putStrLn "Hmm3..."+ writeChan (outEvents (deviceServer s)) $ DOEIQ (iqResult (Just (SID "todo")) Nothing (Just j) Nothing+ (Just (Element { elementName = Name { nameLocalName = DT.pack "simple-variable"+ , namePrefix = Nothing+ , nameNamespace = Just (DT.pack "urn:xmpp:xpmn:0") }+ , elementAttributes = DM.fromList [( Name { nameLocalName = DT.pack "variable"+ , namePrefix = Nothing+ , nameNamespace = Nothing } + , [ContentText $ DT.pack $ simpleVariableName $ pingpongVar s])]+ , elementNodes = (toXML $ simpleVariableValue $ pingpongVar s) })))+ -- TODO: iq result { from, to, id}+ return s+ + processEvent s (IED (DIEIncomingSimpleVariableSet j "pingpong" v)) = do+ putStrLn "Hmm4..."+ pingpongVar' <- (modifySimpleVar $ deviceServer s) (pingpongVar s) (fromXML v)+ writeChan (outEvents (deviceServer s)) $ DOEIQ (iqResult (Just (SID "todo")) Nothing (Just j) Nothing Nothing)+ -- TODO: iq result { from, to, id}+ return s { pingpongVar = pingpongVar' }+ + processEvent s (IED (DIESubscribe j "pingpong")) = do+ pingpongVar' <- (subscribeSimpleVar $ deviceServer s) (pingpongVar s) j+ -- TODO: iq result { from, to, id }+ return s { pingpongVar = pingpongVar' }+ + processEvent s (IED (DIEUnsubscribe j "pingpong")) = do+ let pingpongVar' = (unsubscribeSimpleVar $ deviceServer s) (pingpongVar s) j+ -- TODO: iq result { from, to, id }+ return s { pingpongVar = pingpongVar' }+ + processEvent s (IED (DIESubscribe j "numbers")) = do+ let numbersVar' = (subscribeComplexVar $ deviceServer s) (numbersVar s) j+ -- TODO: iq result { from, to, id }+ return s { numbersVar = numbersVar' }+ + processEvent s (IED (DIEUnsubscribe j "numbers")) = do+ let numbersVar' = (unsubscribeComplexVar $ deviceServer s) (numbersVar s) j+ -- TODO: iq result { from, to, id }+ return s { numbersVar = numbersVar' }+ + processEvent s (IED (DIEItems j "numbers")) = do+ let numbersValues = complexVariableValue (numbersVar s)+ let items = map (\ (i, v) -> NodeElement (Element { elementName = Name { nameLocalName = DT.pack "item"+ , namePrefix = Nothing+ , nameNamespace = Nothing }+ , elementNodes = toXML v+ , elementAttributes = ( DM.fromList [(Name { nameLocalName = DT.pack "id"+ , namePrefix = Nothing+ , nameNamespace = Nothing }, [ContentText (DT.pack i)])])})) numbersValues+ writeChan (outEvents (deviceServer s)) $ DOEIQ (iqResult (Just (SID "todo")) Nothing (Just j) Nothing+ (Just (Element { elementName = Name { nameLocalName = DT.pack "pubsub"+ , namePrefix = Nothing+ , nameNamespace = Just (DT.pack "http://jabber.org/protocol/pubsub") }+ , elementAttributes = DM.fromList []+ , elementNodes = [NodeElement (Element { elementName = Name { nameLocalName = DT.pack "items"+ , namePrefix = Nothing+ , nameNamespace = Nothing }+ , elementAttributes = DM.fromList [(Name { nameLocalName = DT.pack "node"+ , namePrefix = Nothing+ , nameNamespace = Nothing }, [(ContentText (DT.pack "numbers"))])]+ , elementNodes = items } )] })))+ return s+ + processEvent s (IED (DIEQuery j "even-numbers" _)) = do+ let que = query j even :: Query Integer+ return s { stateQueries = que:(stateQueries s) }+ + processEvent s (IED (DIEIQ i)) = do+ putStrLn $ "Got an IQ that was not processed by DeviceServer: " +++ (show i)+ return s+ + processEvent s (IEP b) = do+ -- COMPLEX VAR:+ -- get random number and id+ let (number, stdGen') = randomR (0 :: Integer, 99) (stateStd s)+ idToAdd <- getID+ -- get item to remove+ let idToRemove = fst (last (complexVariableValue (numbersVar s)))+ -- remove id+ c <- (retract (deviceServer s)) (numbersVar s) idToRemove+ -- add id+ c' <- (publish (deviceServer s)) c idToAdd number+ + -- publish to all queries+ q' <- mapM (\ q -> (queryRetract (deviceServer s)) q idToRemove) (stateQueries s)+ q'' <- mapM (\ q -> (queryPublish (deviceServer s)) q idToAdd number) (stateQueries s)+ + case b of+ True -> do+ case simpleVariableValue (pingpongVar s) of+ Ping -> -- Already ping+ return s { numbersVar = c', stateStd = stdGen', stateQueries = q'' }+ Pong -> do+ s' <- (modifySimpleVar (deviceServer s)) (pingpongVar s) Ping+ return s { numbersVar = c', pingpongVar = s', stateStd = stdGen', stateQueries = q'' }+ False -> do+ case simpleVariableValue (pingpongVar s) of+ Ping -> do+ s' <- (modifySimpleVar (deviceServer s)) (pingpongVar s) Pong+ return s { numbersVar = c', pingpongVar = s', stateStd = stdGen', stateQueries = q'' }+ Pong -> -- Already pong+ return s { numbersVar = c', stateStd = stdGen', stateQueries = q'' }+ + processEvent s e = do+ putStrLn $ "!E!E!E!E!E!E!E!E!E!E!: " ++ (show e)+ return s++lolz c c' = do+ e <- readChan c+ writeChan c' (IED e)+ lolz c c'++getFeatures :: [String]+getFeatures = []++pingpong :: Chan InternalEvent -> IO ()+pingpong c = do+ threadDelay 5000000+ writeChan c (IEP False)+ threadDelay 5000000+ writeChan c (IEP True)+ pingpong c
+ Media/XPMN/DeviceServer.hs view
@@ -0,0 +1,820 @@+{-++Copyright © Jon Kristensen, 2010-2011.++This file is part of Pontarius Media Server.++Pontarius Media Server is free software: you can redistribute it and/or modify+it under the terms of the GNU Affero General Public License as published by the+Free Software Foundation, either version 3 of the License, or (at your option)+any later version.++Pontarius Media Server is distributed in the hope that it will be useful, but+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or+FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for+more details.++You should have received a copy of the GNU Affero General Public License along+with Pontarius Media Server. If not, see <http://www.gnu.org/licenses/>.++-}+++-- | Module: $Header$+-- Description: An abstraction layer between Pontarius XMPP and the logic of+-- XPMN devices (controllers and/or services)+-- Copyright: Copyright © 2010-2011 Jon Kristensen+-- License: AGPL-3+-- +-- Maintainer: info@pontarius.org+-- Stability: unstable+-- Portability: portable++-- | A logical entity (application) in an extended personal media network is+-- called an XPMN device. Such devices are service providers, controllers, or+-- both. These devices have a lot in common, such as the need for managing+-- their (XMPP) connections, variables, events, and queries. This module+-- serves as a helping abstraction layer for doing this, exposing as few+-- underlying (XMPP) details as possible.+-- +-- Interaction with this module is mostly event-based. The client works with+-- two functions, one dealing with acquiring DeviceInEvents (received events+-- that are either generated by an (to the client/device) external source+-- (such as another client, the XMPP library or this module)), and another+-- dealing with the transmission of DeviceOutEvents (outgoing events,+-- generated by the client). An example of a DeviceInEvent would be a+-- notification that the device is on-line. A DeviceOutEvent could be a+-- request to set a simple variable in a foreign device. The client acquires+-- these two functions by using the 'start' function, which is the only+-- function that this module exports.+-- +-- More documentation on how to use this module will be available by the time+-- Pontarius XPMN enters beta.++-- Internally, this module uses two channels in its interaction with Pontarius+-- XMPP. The principle here is the same; XMPPInEvents are events generated by+-- Pontarius XMPP and sent to the XMPP client (this module) and XMPPOutEvents+-- are events sent from this XMPP client to Pontarius XMPP.++{-# LANGUAGE PolymorphicComponents #-}++module Media.XPMN.DeviceServer ( ServiceEvent (..)+ , ComplexVariable+ , DeviceInEvent (..)+ , DeviceOutEvent (..)+ , DeviceServer (..)+ , start+ , SimpleVariable+ -- , simpleVariable+ , simpleVariableName+ , simpleVariableValue+ , complexVariable+ , complexVariableValue+ , query+ , XMLable (toXML, fromXML)+ , Query ) where++import Network.XMPP+import Network.XMPP.JID -- TODO++import Control.Concurrent (forkIO)+import Control.Concurrent.Chan (Chan, newChan, readChan, writeChan)+import Data.List (elem, delete)+import Data.Maybe+import Data.String+import Data.XML.Types+import qualified Data.List as DL+import qualified Data.Map as DM+import qualified Data.Text as DT+++-- | All XPMN variables deals with XML in terms of a list of XML nodes.++type VariableValue = [Node]+++-- Undocumented types:+type VariableName = String -- TODO: Document rules, create protected variable.+-- type NodeName = String+type ItemID = String -- TODO: Document rules, create protected variable.+type Subscriber = JID+++-- | An 'XMLable' is a type which can be converted from/to XML.++class XMLable a where+ fromXML :: [Node] -> a+ toXML :: a -> [Node]+++-- | Example instance of the XMLable for an integer.++instance XMLable Integer where+ toXML i = [NodeContent (ContentText (DT.pack (show i)))]+ fromXML [NodeContent (ContentText t)] = read $ DT.unpack t+++-- A pubsub node is basically just an ordered list of ItemIDs and arbitrary+-- objects, and a list of subscribers.++data PubsubNode a = PubsubNode VariableName [(ItemID, a)] [Subscriber]+ deriving (Show)+++-- | A simple XPMN variable is a variable which has only one value. Changing a+-- simple variable overrides its current value.++type SimpleVariable = PubsubNode+++-- | A complex XPMN variable is a variable which has a list of values. You can+-- retract from and publish to a complex variable.++type ComplexVariable = PubsubNode+++data Query a = Query (PubsubNode a) (a -> Bool)+++data DeviceServer = DeviceServer { inEvents :: Chan DeviceInEvent+ , outEvents :: Chan DeviceOutEvent+ , createSimpleVar :: XMLable a =>+ VariableName -> a ->+ [Subscriber] -> IO (SimpleVariable a)+ , modifySimpleVar :: XMLable a =>+ SimpleVariable a -> a ->+ IO (SimpleVariable a)+ , subscribeSimpleVar :: XMLable a =>+ SimpleVariable a ->+ Subscriber ->+ IO (SimpleVariable a)+ , unsubscribeSimpleVar :: XMLable a =>+ SimpleVariable a ->+ Subscriber ->+ SimpleVariable a+ , publish :: XMLable a =>+ ComplexVariable a ->+ ItemID ->+ a ->+ IO (ComplexVariable a)+ , retract :: XMLable a => ComplexVariable a ->+ ItemID -> IO (ComplexVariable a)+ , subscribeComplexVar :: XMLable a =>+ ComplexVariable a ->+ Subscriber ->+ ComplexVariable a+ , unsubscribeComplexVar :: XMLable a =>+ ComplexVariable a ->+ Subscriber ->+ ComplexVariable a+ , queryPublish :: XMLable a => Query a ->+ ItemID -> a -> IO (Query a)+ , queryRetract :: XMLable a => Query a -> ItemID ->+ IO (Query a) }++data Identity = Identity { identityCategory :: String+ , identityType :: String+ , identityName :: Maybe String }++-- TODO: Validate feature string++data InternalEvent = IEX XMPPInEvent | IED DeviceOutEvent deriving (Eq, Show)++data State = State { stateServer :: String+ , statePort :: Integer+ , stateUserName :: String+ , statePassword :: String+ , stateResource :: String+ , stateOurJID :: JID+ , stateVariableNames :: [String]+ , stateQueryNames :: [String] }+++-- TODO: Later: Forward presence and node subscription requests to client.++data DeviceInEvent = DIEIncomingSimpleVariableGet From String |+ DIEIncomingSimpleVariableSet To String [Node] |+ DIEOnline |+ DIEIQ IQ |+ DIEPresence Presence |+ DIESubscribe JID String |+ DIEUnsubscribe JID String |+ DIEQuery JID String [Node] |+ DIEItems Subscriber String+ deriving (Eq, Show)++data DeviceOutEvent = DOEOutgoingSimpleVariableGet From String |+ DOEOutgoingSimpleVariableSet To String [Node] |+ DOEOutgoingSimpleVariableResult To String [Node] |+ DOEIQ IQ |+ DOEPresence Presence |+ DOEMessage Message |+ DOESubscribed JID String+ deriving (Eq, Show)+++-- TODO: Later: First String should be something like StanzaID.+data ServiceEvent = AutoSubscriptionRequest (String, JID) | -- TODO: Only in+ ManualSubscriptionRequest (String, JID) | -- TODO: Only in+ Action (String, JID, Element) |+ ActionResponse (String, JID, Element) |+ SimpleVariableGet (String, JID) |+ SimpleVariableGetResponse (String, JID, String) |+ SimpleVariableSet (String, JID, String) |+ SimpleVariableSetResponse (String, JID, Maybe String) |+ -- IQ ID, _, Item ID, _+ ComplexVariableExtend (String, JID, String, Element) |+ ComplexVariableExtendResponse (String, JID, String, Maybe Element) |+ ComplexVariableRetract (String, JID, String) |+ ComplexVariableRetractResponse (String, JID, Maybe String) deriving (Eq, Show)+++pubsubNodeName :: XMLable a => PubsubNode a -> VariableName+pubsubNodeName (PubsubNode n _ _) = n++pubsubNodeValue :: XMLable a => PubsubNode a -> [(ItemID, a)]+pubsubNodeValue (PubsubNode _ v _) = v++pubsubNodeSubscribers :: XMLable a => PubsubNode a -> [JID]+pubsubNodeSubscribers (PubsubNode _ _ s) = s+++-- Unsubscribes a JID from a simple variable and notifies the subscriber.++unsubscribeFromPubsubNode :: XMLable a => PubsubNode a -> Subscriber -> PubsubNode a++unsubscribeFromPubsubNode p s+ -- JID not subscribed+ | not $ s `elem` subscribers = p+ | otherwise = setPubsubNodeSubscribers p (delete s subscribers)+ where+ subscribers = pubsubNodeSubscribers p+++-- | Create a simple variable with an initial set of subscribers and notify the+-- subscribers of the new value.++simpleVariable :: XMLable a => Chan XMPPOutEvent -> VariableName -> a ->+ [Subscriber] -> IO (SimpleVariable a)++simpleVariable c n v s = do+ let var = PubsubNode n [(n, v)] s+ mapM_ (\ x -> writeChan c (XOEMessage (getSimpleMessage n (toXML v) x))) s+ return var+++simpleVariableName :: XMLable a => SimpleVariable a -> VariableName+simpleVariableName (PubsubNode n _ _) = n++simpleVariableValue :: XMLable a => SimpleVariable a -> a+simpleVariableValue (PubsubNode _ v _) = snd $ head v++simpleVariableSubscribers :: XMLable a => SimpleVariable a -> [Subscriber]+simpleVariableSubscribers (PubsubNode _ _ s) = s+++-- | Modifies a simple variable and notifies the subscribers.++modifySimpleVariable :: XMLable a => Chan XMPPOutEvent -> SimpleVariable a -> a ->+ IO (SimpleVariable a)++modifySimpleVariable c s v = do+ mapM_ (\ x -> writeChan c (XOEMessage (getSimpleMessage name (toXML v) x))) subscribers+ return $ PubsubNode name [(name, v)] subscribers+ where+ name = simpleVariableName s+ subscribers = simpleVariableSubscribers s+++-- No notifications.++setPubsubNodeSubscribers :: XMLable a => PubsubNode a -> [Subscriber] -> PubsubNode a+setPubsubNodeSubscribers (PubsubNode n v _) s = PubsubNode n v s+++-- Subscribes a JID to a simple variable and notifies the subscriber.++subscribeToSimpleVariable :: XMLable a => Chan XMPPOutEvent ->+ SimpleVariable a -> Subscriber ->+ IO (SimpleVariable a)++subscribeToSimpleVariable c si su+ -- JID already subscribed+ | su `elem` simpleVariableSubscribers si = return si+ | otherwise = do+ writeChan c (XOEMessage (getSimpleMessage name (toXML value) su))+ return $ setPubsubNodeSubscribers si (su:subscribers)+ where+ name = simpleVariableName si+ value = simpleVariableValue si+ subscribers = simpleVariableSubscribers si+++-- Unsubscribes a JID from a simple variable and notifies the subscriber.++unsubscribeFromSimpleVariable :: XMLable a => SimpleVariable a -> Subscriber ->+ SimpleVariable a++unsubscribeFromSimpleVariable si su+ -- JID not subscribed+ | not $ su `elem` simpleVariableSubscribers si = si+ | otherwise = setPubsubNodeSubscribers si (delete su subscribers)+ where+ subscribers = simpleVariableSubscribers si+++-- | A complex variable is a pubsub node which can only be published to+-- internally.++complexVariable :: XMLable a => VariableName -> [(ItemID, a)] -> [Subscriber] ->+ ComplexVariable a++complexVariable n v s = PubsubNode n v s+++complexVariableName :: XMLable a => ComplexVariable a -> VariableName+complexVariableName (PubsubNode n _ _) = n++complexVariableValue ::XMLable a => ComplexVariable a -> [(ItemID, a)]+complexVariableValue (PubsubNode _ v _) = v++complexVariableSubscribers :: XMLable a => ComplexVariable a -> [JID]+complexVariableSubscribers (PubsubNode _ _ s) = s+++-- | Modifies a simple variable and notifies the subscribers.++-- TODO: Check if element of list.++publish_ :: XMLable a => Chan XMPPOutEvent -> ComplexVariable a -> ItemID -> a ->+ IO (ComplexVariable a)++publish_ c (PubsubNode n v s) i v_ = do+ mapM_ (\ x ->+ writeChan c (XOEMessage (getComplexPublishMessage n i (toXML v_) x)))+ s+ return newvar+ where+ newvar = PubsubNode n ((i, v_):v) s+++-- | Modifies a simple variable and notifies the subscribers.++retract_ :: XMLable a => Chan XMPPOutEvent -> ComplexVariable a -> ItemID -> IO (ComplexVariable a)++retract_ c (PubsubNode n v s) i = do+ mapM_ (\ x -> writeChan c (XOEMessage (getComplexRetractMessage n i x))) s+ return newvar+ where+ newvar = PubsubNode n v' s+ -- v' is v without the retracted element+ v' = DL.filter (\ x -> fst x /= i) v+++-- Subscribes a JID to a complex variable.++subscribeToComplexVariable :: XMLable a => ComplexVariable a ->+ Subscriber -> ComplexVariable a++subscribeToComplexVariable (PubsubNode n v s) s_+ | s_ `elem` s = PubsubNode n v s+ | otherwise = do+ PubsubNode n v (s_:s)+++-- Unsubscribes a JID from a complex variable.++unsubscribeFromComplexVariable :: XMLable a => ComplexVariable a ->+ Subscriber -> ComplexVariable a+unsubscribeFromComplexVariable (PubsubNode n v s) s_+ | s_ `elem` s = do+ let s' = delete s_ s+ PubsubNode n v s'+ | otherwise = PubsubNode n v s+++query :: XMLable a => Subscriber -> (a -> Bool) -> Query a+query s f = Query (PubsubNode "" [] [s]) f++queryPublish_ :: XMLable a => Chan XMPPOutEvent -> Query a -> ItemID -> a -> IO (Query a)+queryPublish_ c q i v = do+ case (queryFilter q) v of+ True -> do+ pubsubNode <- publish_ c (queryPubsubNode q) i v+ return $ Query pubsubNode (queryFilter q)+ False ->+ return q++queryRetract_ :: XMLable a => Chan XMPPOutEvent -> Query a -> ItemID -> IO (Query a)+queryRetract_ c q i = do+ case DL.lookup i (pubsubNodeValue $ queryPubsubNode q) of+ Just _ -> do+ pubsubNode <- retract_ c (queryPubsubNode q) i+ return $ Query pubsubNode (queryFilter q)+ Nothing -> do+ return q++queryPubsubNode (Query p _) = p+queryFilter (Query _ f) = f+++-- TODO: Validate+identity c t n = Identity { identityCategory = c+ , identityType = t+ , identityName = n }+++start :: String -> Integer -> String -> String -> String -> [String] ->+ [String] -> IO DeviceServer++start s po u pa r v q = do+ -- Create an XMPP session and request to connect+ (xmppIn, xmppOut) <- createSession+ writeChan xmppOut $ XOEConnect s po+ + -- Create the three additional channels that are needed; one internal for the+ -- state loop of this module, and two dealing with the message passing between+ -- this module and the device+ internalChan <- newChan+ deviceIn <- newChan+ deviceOut <- newChan+ + -- Start three threads - one to listen for events from Pontarius XMPP, one for+ -- events from the device and one for the state loop+ forkIO $ xmppListener xmppIn internalChan+ forkIO $ deviceListener deviceOut internalChan+ forkIO $ stateLoop (State { stateServer = s+ , statePort = po+ , stateUserName = u+ , statePassword = pa+ , stateResource = r+ , stateOurJID = jid (Just u) s (Just r)+ , stateVariableNames = v+ , stateQueryNames = q })+ internalChan xmppOut deviceIn+ + return DeviceServer { inEvents = deviceIn+ , outEvents = deviceOut+ , createSimpleVar = simpleVariable xmppOut+ , modifySimpleVar = modifySimpleVariable xmppOut+ , subscribeSimpleVar = subscribeToSimpleVariable xmppOut+ , unsubscribeSimpleVar = unsubscribeFromSimpleVariable+ , publish = publish_ xmppOut+ , retract = retract_ xmppOut+ , subscribeComplexVar = subscribeToComplexVariable+ , unsubscribeComplexVar = unsubscribeFromComplexVariable+ , queryPublish = queryPublish_ xmppOut+ , queryRetract = queryRetract_ xmppOut }+ where+ xmppListener :: Chan XMPPInEvent -> Chan InternalEvent -> IO ()+ xmppListener c c_ = do e <- readChan c+ writeChan c_ $ IEX e+ xmppListener c c_+ + deviceListener :: Chan DeviceOutEvent -> Chan InternalEvent -> IO ()+ deviceListener c c_ = do e <- readChan c+ writeChan c_ $ IED e+ deviceListener c c_+ + stateLoop :: State -> Chan InternalEvent -> Chan XMPPOutEvent ->+ Chan DeviceInEvent -> IO ()+ stateLoop s c c_ c__ = do+ e <- readChan c+ -- putStrLn $ "InternalEvent: " ++ (show e)+ s' <- processEvent s e c_ c__+ stateLoop s c c_ c__+ + -- Processes XMPP events from Pontarius XMPP+ processEvent :: State -> InternalEvent -> Chan XMPPOutEvent ->+ Chan DeviceInEvent -> IO State+ + processEvent s (IEX XIEConnectionSucceeded) c c_ = do+ writeChan c $ XOEAuthenticate (stateUserName s) (statePassword s)+ (stateResource s)+ return s+ + processEvent s (IEX XIEAuthenticationSucceeded) c c_ = do+ writeChan c_ DIEOnline+ writeChan c $ XOEPresence $+ presence Nothing Nothing Nothing Nothing Available []+ return s+ + -- Query for service discovery when someone comes on-line+ processEvent s (IEX (XIEPresence (Presence { presenceStanza = stanza+ , presenceType = Available }))) c c_+ | fromJust (stanzaFrom stanza) /= stateOurJID s = do+ let jid = stanzaFrom stanza+ writeChan c $ XOEIQ $ iqGet Nothing Nothing (stanzaFrom stanza) Nothing+ (Element { elementName = Name { nameLocalName = DT.pack "query"+ , nameNamespace = Just (DT.pack "http://jabber.org/protocol/disco#info")+ , namePrefix = Nothing }+ , elementAttributes = DM.fromList []+ , elementNodes = [] })+ return s+ + -- Auto-accept subscriptions when asked and ask for subscription+ processEvent s (IEX (XIEPresence (Presence { presenceStanza = stanza+ , presenceType = Subscribe }))) c c_ = do+ let jid = stanzaFrom stanza+ writeChan c $ XOEPresence $ presence Nothing Nothing jid Nothing+ Subscribe []+ writeChan c $ XOEPresence $ presence Nothing Nothing jid Nothing+ Subscribed []+ return s+ + -- Reply when service discovery is requested from us+ processEvent s (IEX (XIEIQ (IQGet { iqGetStanza = stanza+ , iqGetPayload = p }))) c c_+ | (nameNamespace $ elementName p) ==+ Just (DT.pack "http://jabber.org/protocol/disco#info") = do+ let jid = stanzaFrom stanza+ writeChan c $ XOEIQ $ iqResult Nothing Nothing jid Nothing+ (Just discoInfoElement)+ return s+ + -- Complex "items" query+ processEvent s (IEX (XIEIQ (IQGet { iqGetStanza = stanza+ , iqGetPayload = p }))) c c_+ | (nameNamespace $ elementName p) == Just (DT.pack "http://jabber.org/protocol/pubsub") &&+ (nameLocalName $ elementName p) == DT.pack "pubsub" &&+ length (elementChildren p) > 0 &&+ (nameLocalName $ elementName $ head (elementChildren p)) == DT.pack "items" = do+ let fromJID = fromJust $ stanzaFrom stanza+ let nodeName = DT.unpack $ fromJust $ attributeText+ (fromString "node") (head (elementChildren p))+ case nodeName `elem` stateVariableNames s of+ True -> do+ writeChan c_ $ DIEItems fromJID nodeName+ return s+ False -> do+ putStrLn "Variable not offered by device (items)!"+ return s+ + -- Simple variable get+ processEvent s (IEX (XIEIQ (IQGet { iqGetStanza = stanza+ , iqGetPayload = p }))) c c_+ | (nameNamespace $ elementName p) == Just (DT.pack "urn:xmpp:xpmn:0") &&+ (nameLocalName $ elementName p) == DT.pack "simple-variable" = do+ let jid = fromJust $ stanzaFrom stanza+ let name = DT.unpack $ fromJust $ attributeText (fromString "name") p+ case name `elem` stateVariableNames s of+ True -> do+ putStrLn "Hmm..."+ writeChan c_ $ DIEIncomingSimpleVariableGet jid name+ return s+ False -> do+ putStrLn "Variable not offered by device (set)!"+ return s+ + -- Simple variable set+ processEvent s (IEX (XIEIQ (IQSet { iqSetStanza = stanza+ , iqSetPayload = p }))) c c_+ | (nameNamespace $ elementName p) == Just (DT.pack "urn:xmpp:xpmn:0") &&+ (nameLocalName $ elementName p) == DT.pack "simple-variable" = do+ let jid = fromJust $ stanzaFrom stanza+ let name = DT.unpack $ fromJust $ attributeText (fromString "name") p+ case name `elem` stateVariableNames s of+ True -> do+ putStrLn "Hmm2..."+ writeChan c_ $ DIEIncomingSimpleVariableSet jid name (elementNodes p)+ return s+ False -> do+ putStrLn "Variable not offered by device (set)!"+ return s+ + -- Variable subscription - simple and complex+ processEvent s (IEX (XIEIQ (IQSet { iqSetStanza = stanza+ , iqSetPayload = p }))) c c_+ | (nameNamespace $ elementName p) == Just (DT.pack "http://jabber.org/protocol/pubsub") &&+ (nameLocalName $ elementName p) == DT.pack "pubsub" &&+ length (elementChildren p) > 0 &&+ (nameLocalName $ elementName $ head (elementChildren p)) == DT.pack "subscribe" = do+ let fromJID = fromJust $ stanzaFrom stanza+ let nodeName = DT.unpack $ fromJust $ attributeText+ (fromString "node") (head (elementChildren p))+ let subscribeJID = fromJust $ stringToJID $ DT.unpack $ fromJust $+ attributeText (fromString "jid") (head (elementChildren p))+ case nodeName `elem` stateVariableNames s of+ True -> do+ writeChan c_ $ DIESubscribe subscribeJID nodeName+ return s+ False -> do+ putStrLn "Variable not offered by device (subscr)!"+ return s+ + -- Variable unsubscription+ processEvent s (IEX (XIEIQ (IQSet { iqSetStanza = stanza+ , iqSetPayload = p }))) c c_+ | (nameNamespace $ elementName p) == Just (DT.pack "http://jabber.org/protocol/pubsub") &&+ (nameLocalName $ elementName p) == DT.pack "pubsub" &&+ length (elementChildren p) > 0 &&+ (nameLocalName $ elementName $ head (elementChildren p)) == DT.pack "unsubscribe" = do+ let fromJID = fromJust $ stanzaFrom stanza+ let nodeName = DT.unpack $ fromJust $ attributeText+ (fromString "node") (head (elementChildren p))+ let subscribeJID = fromJust $ stringToJID $ DT.unpack $ fromJust $+ attributeText (fromString "jid") (head (elementChildren p))+ case nodeName `elem` stateVariableNames s of+ True -> do+ writeChan c_ $ DIEUnsubscribe subscribeJID nodeName+ return s+ False -> do+ putStrLn "Variable not offered by device (unsubscr)!"+ return s+ + -- Query+ processEvent s (IEX (XIEIQ (IQSet { iqSetStanza = stanza+ , iqSetPayload = p }))) c c_+ | (nameLocalName $ elementName p) == DT.pack "query" &&+ (nameNamespace $ elementName p) /= Nothing && + DT.unpack (fromJust (nameNamespace $ elementName p)) `elem` stateQueryNames s = do+ let fromJID = fromJust $ stanzaFrom stanza+ let nodeName = DT.unpack (fromJust $ nameNamespace $ elementName p)+ let nodes = elementNodes p+ writeChan c_ $ DIEQuery fromJID nodeName nodes+ return s+ + -- Service discovery result, auto-subscribe user to relevant variables+ -- TODO: Verify that auto-subscription is detected+ processEvent s (IEX (XIEIQ (IQResult { iqResultStanza = stanza+ , iqResultPayload = p }))) c c_+ | p /= Nothing &&+ (nameNamespace $ elementName $ fromJust p) ==+ Just (DT.pack "http://jabber.org/protocol/disco#info") = do+ let jid = fromJust $ stanzaFrom stanza+ -- Get all features elements+ let features = filter (\ x -> not $ null (isNamed (Name { nameLocalName = DT.pack "feature"+ , nameNamespace = Just (DT.pack "http://jabber.org/protocol/disco#info")+ , namePrefix = Nothing }) x)) (elementChildren $ fromJust p)+ -- Features to strings+ let features_ = map (\ x -> DT.unpack $ fromJust $ attributeText (fromString "var") x) features+ + -- For each string in variables, check if "[string]+notify" is part of features_+ let autovars = filter (\ x -> x ++ "+notify" `elem` features_) (stateVariableNames s)+ + mapM_ (\ x -> writeChan c_ $ DIESubscribe jid x) autovars+ + return s+ + -- Other IQ, send it to device+ processEvent s (IEX (XIEIQ iq)) c c_ = do+ putStrLn "This is happening"+ writeChan c_ $ DIEIQ iq+ return s+ + -- Get an external simple variable+ processEvent s (IED (DOEOutgoingSimpleVariableGet j n)) c c_ = do+ writeChan c $ XOEIQ $ iqGet Nothing Nothing (Just j) Nothing+ (Element { elementName = Name { nameLocalName = DT.pack "simple-variable"+ , namePrefix = Nothing+ , nameNamespace = Just (DT.pack "urn:xmpp:xpmn:0") }+ , elementAttributes = DM.fromList [( Name { nameLocalName = DT.pack "variable"+ , namePrefix = Nothing+ , nameNamespace = Nothing } + , [ContentText (DT.pack n)])]+ , elementNodes = [] })+ return s+ + -- Set an external simple variable+ processEvent s (IED (DOEOutgoingSimpleVariableSet j n v)) c c_ = do+ writeChan c $ XOEIQ $ iqSet Nothing Nothing (Just j) Nothing+ (Element { elementName = Name { nameLocalName = DT.pack "simple-variable"+ , namePrefix = Nothing+ , nameNamespace = Just (DT.pack "urn:xmpp:xpmn:0") }+ , elementAttributes = DM.fromList [( Name { nameLocalName = DT.pack "variable"+ , namePrefix = Nothing+ , nameNamespace = Nothing } + , [ContentText (DT.pack n)])]+ , elementNodes = v }) -- Only difference from above+ return s+ + -- -- Set an external simple variable+ -- processEvent s (IED (DOEOutgoingSimpleVariableResult j n v)) c c_ = do+ -- writeChan c $ XOEIQ $ iqResult Nothing Nothing (Just j) Nothing+ -- (Just (Element { elementName = Name { nameLocalName = DT.pack "simple-variable"+ -- , namePrefix = Nothing+ -- , nameNamespace = Just (DT.pack "urn:xmpp:xpmn:0") }+ -- , elementAttributes = DM.fromList [( Name { nameLocalName = DT.pack "variable"+ -- , namePrefix = Nothing+ -- , nameNamespace = Nothing } + -- , [ContentText (DT.pack n)])]+ -- , elementNodes = v })) -- Only difference from above+ -- return s+ + -- Send a device-specific IQ+ processEvent s (IED (DOEIQ i)) c c_ = do+ writeChan c $ XOEIQ i+ return s+ + processEvent s (IEX xmppEvent) c c_ = do+ putStrLn $ "Uncaught XMPP Event: " ++ (show xmppEvent)+ return s+ + processEvent s (IED deviceEvent) c c_ = do+ putStrLn $ "Uncaught Device Event: " ++ (show deviceEvent)+ return s+ + discoInfoElement :: Element+ discoInfoElement = (Element { elementName = fromString "query"+ , elementAttributes = DM.empty+ , elementNodes = identities (snd $+ features___ []) +++ features (fst $+ features___ fea) })+ identities :: [Identity] -> [Node]+ identities [] = []+ identities (i':is) = (NodeElement (Element { elementName = fromString "identity"+ , elementAttributes = DM.fromList $ attrList i'+ , elementNodes = [] })):(identities is)+ attrList :: Identity -> [(Name, [Content])]+ attrList i' = case identityName i' of+ Just name -> [(fromString "category", [ContentText $ DT.pack $ identityCategory i']),+ (fromString "type", [ContentText $ DT.pack $ identityType i']),+ (fromString "name", [ContentText $ DT.pack $ name])]+ Nothing -> [(fromString "category", [ContentText $ DT.pack $ identityCategory i']),+ (fromString "type", [ContentText $ DT.pack $ identityType i'])]+ + features :: [String] -> [Node]+ features [] = []+ features (f:fs) = (NodeElement (Element { elementName = fromString "feature"+ , elementAttributes = DM.fromList [(fromString "var", [ContentText $ DT.pack f])]+ , elementNodes = [] })):(features fs)+ + -- TODO: Should be configured by the device client later+ features___ :: [String] -> ([String], [Identity])+ features___ f = case elem "http://jabber.org/protocol/disco#info" f of + False -> (("http://jabber.org/protocol/disco#info":features'___ f),+ [Identity { identityCategory = "xpmn"+ , identityType = "service"+ , identityName = Nothing }]) -- TODO+ True -> (features'___ f , [Identity { identityCategory = "xpmn"+ , identityType = "service"+ , identityName = Nothing }]) -- TODO+ features'___ [] = []+ features'___ (f:fs) = (f:(features'___ fs))++ fea :: [String]+ fea = ["pingpong+notify"]+++getSimpleMessage :: VariableName -> VariableValue -> JID -> Message++getSimpleMessage n v s = message Nothing Nothing (Just s) Nothing Normal [event]+ where+ event :: Element+ event = Element { elementName = Name { nameLocalName = DT.pack "event"+ , nameNamespace = Just (DT.pack "http://jabber.org/protocol/pubsub#event")+ , namePrefix = Nothing }+ , elementAttributes = DM.fromList []+ , elementNodes = [NodeElement items] }+ items :: Element+ items = Element { elementName = fromString "items"+ , elementAttributes = DM.fromList [(fromString "node", [ContentText (DT.pack n)])]+ , elementNodes = [NodeElement item] }+ item :: Element+ item = Element { elementName = fromString "item"+ , elementAttributes = DM.fromList [(fromString "id", [ContentText (DT.pack n)])]+ , elementNodes = v }+++getComplexPublishMessage :: VariableName -> ItemID -> VariableValue ->+ Subscriber -> Message++getComplexPublishMessage n i v s = message Nothing Nothing (Just s) Nothing+ Normal [event]+ where+ event :: Element+ event = Element { elementName = Name { nameLocalName = DT.pack "event"+ , nameNamespace = Just (DT.pack "http://jabber.org/protocol/pubsub#event")+ , namePrefix = Nothing }+ , elementAttributes = DM.fromList []+ , elementNodes = [NodeElement items] }+ items :: Element+ items = Element { elementName = fromString "items"+ , elementAttributes = DM.fromList [(fromString "node", [ContentText (DT.pack n)])]+ , elementNodes = [NodeElement item] }+ item :: Element+ item = Element { elementName = fromString "item"+ , elementAttributes = DM.fromList [(fromString "id", [ContentText (DT.pack i)])]+ , elementNodes = v }+++getComplexRetractMessage :: VariableName -> ItemID -> Subscriber -> Message++getComplexRetractMessage n i s = message Nothing Nothing (Just s) Nothing Normal+ [event]+ where+ event :: Element+ event = Element { elementName = Name { nameLocalName = DT.pack "event"+ , nameNamespace = Just (DT.pack "http://jabber.org/protocol/pubsub#event")+ , namePrefix = Nothing }+ , elementAttributes = DM.fromList []+ , elementNodes = [NodeElement items] }+ items :: Element+ items = Element { elementName = fromString "items"+ , elementAttributes = DM.fromList [(fromString "node", [ContentText (DT.pack n)])]+ , elementNodes = [NodeElement retract] }+ retract :: Element+ retract = Element { elementName = fromString "retract"+ , elementAttributes = DM.fromList [(fromString "id", [ContentText (DT.pack i)])]+ , elementNodes = [] }
+ README view
@@ -0,0 +1,22 @@+Pontarius XPMN aims to be an efficient and easy-to-use XPMN library for Haskell.+This project was "forked" from Pontarius Media Server 1.0 Alpha 1 since we+wanted to make our XPMN module available to other projects as well.++Pontarius XPMN is still prototyped but it's maturing rapidly.++Please note that we are not recommending anyone to use Pontarius XPMN at this+time as it’s still in an experimental stage and will have its API and data types+modified frequently. That being said, if you are interested to use Pontarius+XPMN anyway, feel free to contact the Pontarius project and we will try to help+you get started. Also, see the Examples directory for an example on how devices+are currently implemented.++We are currently working on cleaning up the API and securing client-to-client+communications.++We will release the next version, 1.0 Alpha 2, on the 4th of May.++Look at the Pontarius web site <http://www.pontarius.org/>, the Pontarius XPMN+web page <http://www.pontarius.org/projects/pontarius-xpmn/> and the Pontarius+XPMN Hackage page <http://hackage.haskell.org/package/pontarius-xpmn/> for more+information.
+ Setup.hs view
@@ -0,0 +1,3 @@+import Distribution.Simple++main = defaultMain
+ agpl.txt view
@@ -0,0 +1,661 @@+ GNU AFFERO GENERAL PUBLIC LICENSE+ Version 3, 19 November 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU Affero General Public License is a free, copyleft license for+software and other kinds of works, specifically designed to ensure+cooperation with the community in the case of network server software.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+our General Public Licenses are intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ Developers that use our General Public Licenses protect your rights+with two steps: (1) assert copyright on the software, and (2) offer+you this License which gives you legal permission to copy, distribute+and/or modify the software.++ A secondary benefit of defending all users' freedom is that+improvements made in alternate versions of the program, if they+receive widespread use, become available for other developers to+incorporate. Many developers of free software are heartened and+encouraged by the resulting cooperation. However, in the case of+software used on network servers, this result may fail to come about.+The GNU General Public License permits making a modified version and+letting the public access it on a server without ever releasing its+source code to the public.++ The GNU Affero General Public License is designed specifically to+ensure that, in such cases, the modified source code becomes available+to the community. It requires the operator of a network server to+provide the source code of the modified version running there to the+users of that server. Therefore, public use of a modified version, on+a publicly accessible server, gives the public access to the source+code of the modified version.++ An older license, called the Affero General Public License and+published by Affero, was designed to accomplish similar goals. This is+a different license, not a version of the Affero GPL, but Affero has+released a new version of the Affero GPL which permits relicensing under+this license.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU Affero General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Remote Network Interaction; Use with the GNU General Public License.++ Notwithstanding any other provision of this License, if you modify the+Program, your modified version must prominently offer all users+interacting with it remotely through a computer network (if your version+supports such interaction) an opportunity to receive the Corresponding+Source of your version by providing access to the Corresponding Source+from a network server at no charge, through some standard or customary+means of facilitating copying of software. This Corresponding Source+shall include the Corresponding Source for any work covered by version 3+of the GNU General Public License that is incorporated pursuant to the+following paragraph.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the work with which it is combined will remain governed by version+3 of the GNU General Public License.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU Affero General Public License from time to time. Such new versions+will be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++ Each version is given a distinguishing version number. If the+Program specifies that a certain numbered version of the GNU Affero General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU Affero General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU Affero General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU Affero General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU Affero General Public License for more details.++ You should have received a copy of the GNU Affero General Public License+ along with this program. If not, see <http://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If your software can interact with users remotely through a computer+network, you should also make sure that it provides a way for users to+get its source. For example, if your program is a web application, its+interface could display a "Source" link that leads users to an archive+of the code. There are many ways you could offer source, and different+solutions will be better for different programs; see section 13 for the+specific requirements.++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU AGPL, see+<http://www.gnu.org/licenses/>.
+ install.sh view
@@ -0,0 +1,5 @@+#!/bin/sh+runhaskell Setup.hs configure --user+runhaskell Setup.hs build+runhaskell Setup.hs install+
+ pontarius-xpmn.cabal view
@@ -0,0 +1,87 @@+-- TODO: Set dependency versions.+-- TODO: Highlighting bug: The last line of the description.++Name: pontarius-xpmn+Version: 0.0.1.0+Cabal-Version: >= 1.6+Build-Type: Simple+License: OtherLicense+License-File: agpl.txt+Copyright: Copyright © Jon Kristensen, 2010-2011+Author: Jon Kristensen, Mahdi Abdinejadi+Maintainer: jon.kristensen@pontarius.org+Stability: alpha+Homepage: http://www.pontarius.org/projects/pontarius-xpmn/+Bug-Reports: mailto:info@pontarius.org+Package-URL: http://www.pontarius.org/releases/pontarius-xpmn-0.0.1.0.tar.gz+Synopsis: Extended Personal Media Network (XPMN) library+Description: Manages Extended Personal Media Network (XPMN) devices.+Category: Media+Tested-With: GHC ==6.12.3+-- Data-Files:+-- Data-Dir:+-- Extra-Source-Files:+-- Extra-Tmp-Files:++-- uuid+Library+ Exposed-Modules: Media.XPMN.DeviceServer+ Exposed: True+ Build-Depends: pontarius-xmpp ==0.0.3.0, base >= 2 && < 5, random,+ containers, text, xml-types+ -- Other-Modules:+ -- HS-Source-Dirs:+ -- Extensions:+ -- Build-Tools:+ -- Buildable:+ -- GHC-Options:+ -- GHC-Prof-Options:+ -- Hugs-Options:+ -- NHC98-Options:+ -- Includes:+ -- Install-Includes:+ -- Include-Dirs:+ -- C-Sources:+ -- Extra-Libraries:+ -- Extra-Lib-Dirs:+ -- CC-Options:+ -- LD-Options:+ -- Pkgconfig-Depends:+ -- Frameworks:++-- Executable pontarius-mediaserver-test+ -- Main-Is: Main.hs+ -- Build-Depends: pontarius-xmpp ==0.0.3.0, base >= 2 && < 5, random,+ -- containers, text, xml-types+ -- Other-Modules:+ -- HS-Source-Dirs:+ -- Extensions:+ -- Build-Tools:+ -- Buildable:+ -- GHC-Options:+ -- GHC-Prof-Options:+ -- Hugs-Options:+ -- NHC98-Options:+ -- Includes:+ -- Install-Includes:+ -- Include-Dirs:+ -- C-Sources:+ -- Extra-Libraries:+ -- Extra-Lib-Dirs:+ -- CC-Options:+ -- LD-Options:+ -- Pkgconfig-Depends:+ -- Frameworks:++Source-Repository head+ Type: darcs+ -- Module:+ Location: https://patch-tag.com/r/jonkri/pontarius-xpmn+ -- Subdir:++Source-Repository this+ Type: darcs+ -- Module:+ Location: https://patch-tag.com/r/jonkri/pontarius-xpmn+ Tag: 0.0.1.0+ -- Subdir: