Changeset 658

Timestamp:

05/11/08 12:39:06 (7 months ago)

Author:

sylvain

Message:

Expanded simplechat example
Fixed presence/roster support

Files:

• oss/headstock/headstock/api/contact.py (modified) (5 diffs)
• oss/headstock/headstock/example/simplechat/simplechat.py (modified) (9 diffs)
• oss/headstock/headstock/protocol/core/presence.py (modified) (3 diffs)

oss/headstock/headstock/api/contact.py

@@ -15 +15 @@
-
-class Presence(Entity):
-
-
+, type=u'none', stanza_id=None
+, type=type, stanza_id=stanza_id
-        self.status = None
-        self.show = None
-        self.priority = 0
-        self.subscription = u'none'
-        self.foreign = []
-
@@ -29 +28 @@
-    def from_element(e):
-        p = Presence(JID.parse(e.get_attribute_value('from')),
-)
-p.subscription = e.get_attribute_value('type', None
+,
+             e.get_attribute_value('type', None)
-
-        for child in e.xml_children:
@@ -52 +51 @@
-        if p.to_jid:
-            attrs[u'to'] = unicode(p.to_jid)
-subscription
-subscription
+type
+type
-        e = E(u'presence', attributes=attrs, namespace=XMPP_CLIENT_NS)
-
@@ -85 +84 @@
-
-class Roster(Entity):
-
-
+=None, type=u'get', stanza_id=None
+, type=type, stanza_id=stanza_id
-        self.items = {}
-
@@ -109 +108 @@
-                
-        return r
+
+    @staticmethod
+    def to_element(e):
+        iq = Entity.to_element(e)
+        if e.type != 'result':
+            query = E(u'query', namespace=XMPP_ROSTER_NS, parent=iq)
+            for item_id in e.items:
+                item = e.items[item_id]
+                attr = {u'jid': unicode(item.jid)}
+                if item.subscription:
+                    attr[u'subscription'] = item.subscription
+                if item.name:
+                    attr[u'name'] = item.name
+                if item.language:
+                    attr[u'language'] = item.language
+                i = E(u'item', namespace=XMPP_ROSTER_NS,
+                      attributes=attr, parent=query)
+                for group in item.groups:
+                    E(u'group', namespace=XMPP_ROSTER_NS,
+                      content=group, parent=i)
+        return iq
+        

oss/headstock/headstock/example/simplechat/simplechat.py

@@ -35 +35 @@
-    
-from headstock.protocol.core.stream import ClientStream, StreamError, SaslError
-, PresenceSubscriber
+
-from headstock.protocol.core.roster import RosterDispatcher, RosterNull
-from headstock.protocol.core.message import MessageDispatcher, MessageEchoer
@@ -45 +45 @@
-from headstock.lib.logger import Logger
-from headstock.api.im import Message, Body, Event
-
+
+
-from headstock.api.activity import Activity
-from headstock.lib.utils import generate_unique
@@ -58 +59 @@
-    Inboxes = {"inbox"        : "headstock.api.contact.Roster instance",
-               "control"      : "stops the component",
+               "pushed"       : "roster stanzas pushed by the server",
-               "jid"          : "headstock.api.jid.JID instance received from the server",
-               "ask-activity" : "request activity status to the server for each roster contact"}
@@ -64 +66 @@
-                "signal"      : "Shutdown signal",
-                "message"     : "Message to send",
+                "result"      : "", 
-                "activity"    : "headstock.api.activity.Activity instance to send to the server"}
-
@@ -96 +99 @@
-                self.from_jid = self.recv('jid')
-            
+            if self.dataReady("pushed"):
+                roster = self.recv('pushed')
+                for nodeid in roster.items:
+                    self.send(Roster(from_jid=self.from_jid, to_jid=nodeid,
+                                     type=u'result', stanza_id=generate_unique()), 'result')
+                
-            if self.dataReady("inbox"):
-                roster = self.recv("inbox")
@@ -309 +318 @@
-            yield 1
-
+class PresenceHandler(component):
+    Inboxes = {"inbox"       : "headstock.api.contact.Presence instance",
+               "control"     : "Shutdown the client stream",
+               "subscribe"   : "",
+               "unsubscribe" : "",}
+    
+    Outboxes = {"outbox" : "headstock.api.contact.Presence instance to return to the server",
+                "signal" : "Shutdown signal",
+                "roster" : "",
+                "log"    : "log",}
+    
+    def __init__(self):
+        super(PresenceHandler, self).__init__()
+
+    def main(self):
+        while 1:
+            if self.dataReady("control"):
+                mes = self.recv("control")
+                
+                if isinstance(mes, shutdownMicroprocess) or isinstance(mes, producerFinished):
+                    self.send(producerFinished(), "signal")
+                    break
+
+            if self.dataReady("subscribe"):
+                p = self.recv("subscribe")
+                p.swap_jids()
+                
+                # Automatically accept any subscription requests
+                p = Presence(from_jid=p.from_jid, to_jid=unicode(p.to_jid),
+                             type=u'subscribed')
+                self.send(p, "outbox")
+                
+                # Automatically subscribe in return as well
+                p = Presence(from_jid=p.from_jid, to_jid=unicode(p.to_jid),
+                             type=u'subscribe')
+                self.send(p, "outbox")
+                
+            if self.dataReady("unsubscribe"):
+                p = self.recv("unsubscribe")
+                p.swap_jids()
+                
+                # We stop our subscription to the other user
+                p = Presence(from_jid=p.from_jid, to_jid=unicode(p.to_jid),
+                             type=u'unsubscribed')
+                self.send(p, "outbox")
+                
+                # We stop the other user's subscription
+                p = Presence(from_jid=p.from_jid, to_jid=unicode(p.to_jid),
+                             type=u'unsubscribe')
+                self.send(p, "outbox")
+
+                # We remove this user from our roster list
+                r = Roster(from_jid=p.from_jid, type=u'set')
+                i = Item(p.to_jid)
+                i.subscription = u'remove'
+                r.items[unicode(p.to_jid)] = i
+                self.send(r, 'roster')
+
+                # We tell the other user we're not available anymore
+                p = Presence(from_jid=p.from_jid, to_jid=unicode(p.to_jid),
+                             type=u'unavailable')
+                self.send(p, "outbox")
+                
+            if not self.anyReady():
+                self.pause()
+  
+            yield 1
+    
+
-class Client(component):
-    Inboxes = {"inbox"    : "",
@@ -336 +414 @@
-        return self.password
-
-    def subscription_requested(self, p):
-        # If you don't accept the subscription request, simply return None
-        # otherwise returns "p"
-
-        # Note that you could for instance call your database, or ask the
-        # user, etc.
-        print "# %s wants to subscribe to you. Enter 'yes' to allow, 'no' otherwise" % str(p.from_jid)
-        allow = raw_input(">>> ")
-        if allow == 'yes':
-            p.swap_jids()
-            return p
-
-    def shutdown(self):
-
-
-
+
-        self.send('OUTGOING : </stream:stream>', 'log')
-        self.send('</stream:stream>', 'outbox') 
@@ -408 +472 @@
-                               rosterhandler = RosterHandler(self.jid),
-                               msgdummyhandler = DummyMessageHandler(),
+                               presencehandler = PresenceHandler(),
-                               presencedisp = PresenceDispatcher(),
-                               presencesub = PresenceSubscriber(self.subscription_requested),
-                               rosterdisp = RosterDispatcher(),
-                               msgdisp = MessageDispatcher(),
@@ -436 +500 @@
-                                           ("xmpp", "%s.presence" % XMPP_CLIENT_NS): ("presencedisp", "inbox"),
-                                           ("presencedisp", "log"): ('logger', "inbox"),
-
-
+
+
+
+
+
-
-                                           # Roster
-                                           ("xmpp", "%s.query" % XMPP_ROSTER_NS): ("rosterdisp", "inbox"),
-                                           ("rosterdisp", "log"): ('logger', "inbox"),
+                                           ('rosterdisp', 'xmpp.set'): ('rosterhandler', 'pushed'),
-                                           ('rosterdisp', 'xmpp.result'): ('rosterhandler', 'inbox'),
+                                           ('rosterhandler', 'result'): ('rosterdisp', 'forward'),
+                                           ("rosterdisp", "outbox"): ("xmpp", "forward"),
-
-                                           # Discovery

oss/headstock/headstock/protocol/core/presence.py

@@ -12 +12 @@
-from bridge.common import XMPP_CLIENT_NS
-
-, 'PresenceSubscriber'
+
-
-# Helper function
-def create_presence(from_jid=None, to_jid=None, presence_type=None, status=None, show=None):
-    stanza = Stanza(u'presence', from_jid, to_jid, presence_type)
-    if status:
-        E(u'status', content=status, namespace=stanza.xml_ns, parent=stanza)
-    if show:
-        E(u'show', content=show, namespace=stanza.xml_ns, parent=stanza)
-        
-    return stanza.to_element()
-    
-class PresenceDispatcher(component):
-    Inboxes = {"inbox"              : "bridge.Element instance",
-Shutdown the client stream
+stops the component
-               "forward"            : "headstock.api.contact.Presence instance to be sent back to the client. Transforms the instance to a bridge.Element instance and puts it into the 'outbox'",
-               }
@@ -34 +24 @@
-                "log"               : "log",
-                "unknown"           : "Unknown element that could not be dispatched properly",
+                "xmpp.unavailable"  : "Notifiy an entity of one's availability",
-                "xmpp.error"        : "An error has occurred regarding processing or delivery of a presence stanza",
-                "xmpp.probe"        : "Server to server message to check the presence of an entity",
@@ -78 +69 @@
-  
-            yield 1
-
-class PresenceSubscriber(component):
-    Inboxes = {"inbox"              : "headstock.api.contact.Presence instance",
-               "control"            : "Shutdown the client stream",
-               }
-    
-    Outboxes = {"outbox"            : "bridge.Element instance to sent back to the client",
-                "signal"            : "Shutdown signal",
-                }
-    
-    def __init__(self, subscribe_cb):
-        """
-        Component that handles passing the message to the server that a subscribtion
-        was either allowed or refused.
-
-        The ``subscribe_cb`` must be a callable that takes a headstock.api.contact.Presence instance
-        and returns either that instance to allow the subscription or None to reject it.
-        """
-        super(PresenceSubscriber, self).__init__()
-        self.subscribe_cb = subscribe_cb
-
-    def main(self):
-        while 1:
-            if self.dataReady("control"):
-                mes = self.recv("control")
-                
-                if isinstance(mes, shutdownMicroprocess) or isinstance(mes, producerFinished):
-                    self.send(producerFinished(), "signal")
-                    break
-
-            if self.dataReady("inbox"):
-                p = self.recv("inbox")
-
-                action = self.subscribe_cb(p)
-                if action == None:
-                    e = create_presence(to_jid=unicode(p.to_jid),
-                                        presence_type=u'unsubscribed')
-                else:
-                    # action is now the new instance of 'p' and may have been
-                    # modified by the callback function
-                    e = create_presence(to_jid=unicode(action.to_jid),
-                                        presence_type=u'subscribed')
-
-                self.send(e, "outbox")
-                
-            if not self.anyReady():
-                self.pause()
-  
-            yield 1
-    
-
-class PresenceUnsubscriber(component):
-    Inboxes = {"inbox"              : "bridge.Element instance",
-               "control"            : "Shutdown the client stream",
-               }
-    
-    Outboxes = {"outbox"            : "bridge.Element instance to sent back to the client",
-                "signal"            : "Shutdown signal",
-                "log"               : "log",
-                }
-    
-    def __init__(self):
-       super(PresenceUnsubscriber, self).__init__() 
-
-    def main(self):
-        while 1:
-            if self.dataReady("control"):
-                mes = self.recv("control")
-                
-                if isinstance(mes, shutdownMicroprocess) or isinstance(mes, producerFinished):
-                    self.send(producerFinished(), "signal")
-                    break
-
-            if self.dataReady("inbox"):
-                e = self.recv("inbox")
-                
-            if not self.anyReady():
-                self.pause()
-  
-            yield 1
-