Changeset 141:3a9bff4e7807 for wokkel/xmppim.py

Timestamp:

Aug 4, 2011, 9:38:24 PM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Message:

Use descendants from wokkel.generic.Stanza in messages and presence.

• Use wokkel.xmppim.AvailabilityPresence as a basis for presence stanzas.
• Split wokkel.xmppim.PresenceProtocol and Base MUCClient on BasePresenceProtocol
• Add new wokkel.xmppim.Message as the basis for message stanzas.
• `receivedGroupChat
• Change order of parameters for invite, as reason is optional.
• Use datetimes everywhere where timestamps are needed.

File:

• wokkel/xmppim.py (modified) (5 diffs)

wokkel/xmppim.py

@@ -297 +297 @@
 
 
+    def __get_status(self):
+        if None in self.statuses:
+            return self.statuses[None]
+        elif self.statuses:
+            for status in self.status.itervalues():
+                return status
+        else:
+            return None
+
+    status = property(__get_status)
+
+
     def _childParser_show(self, element):
         show = unicode(element)
@@ -368 +380 @@
 
 
-class PresenceProtocol(XMPPHandler):
-    """
-    XMPP Presence protocol.
+class BasePresenceProtocol(XMPPHandler):
+    """
+    XMPP Presence base protocol handler.
+
+    This class is the base for protocol handlers that receive presence
+    stanzas. Listening to all incoming presence stanzas, it extracts the
+    stanza's type and looks up a matching stanza parser and calls the
+    associated method. The method's name is the type + C{Received}. E.g.
+    C{availableReceived}. See L{PresenceProtocol} for a complete example.
 
     @cvar presenceTypeParserMap: Maps presence stanza types to their respective
@@ -376 +394 @@
     @type presenceTypeParserMap: C{dict}
     """
+
+    presenceTypeParserMap = {}
+
+    def connectionInitialized(self):
+        self.xmlstream.addObserver("/presence", self._onPresence)
+
+
+
+    def _onPresence(self, element):
+        """
+        Called when a presence stanza has been received.
+        """
+        stanza = Stanza.fromElement(element)
+
+        presenceType = stanza.stanzaType or 'available'
+
+        try:
+            parser = self.presenceTypeParserMap[presenceType]
+        except KeyError:
+            return
+
+        presence = parser.fromElement(element)
+
+        try:
+            handler = getattr(self, '%sReceived' % presenceType)
+        except AttributeError:
+            return
+        else:
+            handler(presence)
+
+
+
+class PresenceProtocol(BasePresenceProtocol):
 
     presenceTypeParserMap = {
@@ -386 +437 @@
                 'unsubscribed': SubscriptionPresence,
                 'probe': ProbePresence,
-        }
-
-    def connectionInitialized(self):
-        self.xmlstream.addObserver("/presence", self._onPresence)
-
-
-    def _onPresence(self, element):
-        stanza = Stanza.fromElement(element)
-
-        presenceType = stanza.stanzaType or 'available'
-
-        try:
-            parser = self.presenceTypeParserMap[presenceType]
-        except KeyError:
-            return
-
-        presence = parser.fromElement(element)
-
-        try:
-            handler = getattr(self, '%sReceived' % presenceType)
-        except AttributeError:
-            return
-        else:
-            handler(presence)
+                }
 
 
@@ -700 +728 @@
         """
 
+
+
+class Message(Stanza):
+    """
+    A message stanza.
+    """
+
+    stanzaKind = 'message'
+
+    childParsers = {
+            (None, 'body'): '_childParser_body',
+            (None, 'subject'): '_childParser_subject',
+            }
+
+    def __init__(self, recipient=None, sender=None, body=None, subject=None):
+        Stanza.__init__(self, recipient, sender)
+        self.body = body
+        self.subject = subject
+
+
+    def _childParser_body(self, element):
+        self.body = unicode(element)
+
+
+    def _childParser_subject(self, element):
+        self.subject = unicode(element)
+
+
+    def toElement(self):
+        element = Stanza.toElement(self)
+
+        if self.body:
+            element.addElement('body', content=self.body)
+        if self.subject:
+            element.addElement('subject', content=self.subject)
+
+        return element
+
+
+
 class MessageProtocol(XMPPHandler):
     """