Changeset 73:f574beee3bca in ralphm-patches for message-stanza.patch

Timestamp:

May 6, 2013, 10:01:18 PM (9 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Children:

74:355afce3af27, 75:9b7b8b99da61

Message:

Minor cleanups, improved error message handling, and upstreamed patch.

• Upstreamed deprecation of prepareIDNName.
• MessageProtocol? now properly handles error message stanzas.
• Renamed methods for RosterServerProtocol?.
• Prefer connectionInitialized for setting up stanza observers.

File:

• message-stanza.patch (modified) (8 diffs)

message-stanza.patch

@@ -1 +1 @@
 # HG changeset patch
-# Parent 4d9f583550dd048922d89ea09c60cd082b6c2c65
+# Parent a94e14d79311f8efde3bd001ce4b5c8bafbb8094
+Parse message stanzas into Message objects.
+
+This replaces `MessageProtocol.onMessage` with `messageReceived` and
+`errorReceived`.
+
+Incoming messages stanzas are parsed by the `fromElement` class method
+of the class set in `MessageProtocol.messageFactory`. This defaults to
+the `Message` class.  The resulting object is passed to
+`messageReceived`.
+
+If the message type was `error`, the message is parsed as a
+`wokkel.generic.ErrorStanza` instead, and passed to `errorReceived`.
+
+`Message` now normalizes the message type of empty or unknown values to
+`normal` per RFC 6120.
 
 diff --git a/wokkel/test/test_xmppim.py b/wokkel/test/test_xmppim.py
 --- a/wokkel/test/test_xmppim.py
 +++ b/wokkel/test/test_xmppim.py
-@@ -1336,3 +1336,186 @@
+@@ -1336,3 +1336,213 @@
          d = self.handleRequest(xml)
          d.addCallback(cb)
@@ -112 +127 @@
 +        stanza = received[-1]
 +        self.assertEqual(u'Hello', stanza.body)
++
++
++    def test_errorReceived(self):
++        """
++        Message stanzas of type error are received by errorReceived.
++        """
++        messagesReceived = []
++        errorsReceived = []
++        self.patch(self.protocol, 'messageReceived', messagesReceived.append)
++        self.patch(self.protocol, 'errorReceived', errorsReceived.append)
++
++        xml = """
++          <message to='example.org' type='error'>
++            <error type='cancel'>
++              <service-unavailable
++                  xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
++            </error>
++          </message>
++        """
++
++        message = parseXml(xml)
++        self.stub.send(message)
++
++        self.assertEqual(0, len(messagesReceived))
++        self.assertEqual(1, len(errorsReceived))
++        stanza = errorsReceived[-1]
++        self.assertEqual(u'service-unavailable', stanza.exception.condition)
 +
 +
@@ -220 +262 @@
  
      def __init__(self, recipient=None, sender=None, body=None, subject=None):
-@@ -1031,39 +1034,68 @@
+@@ -1031,39 +1034,84 @@
          element = Stanza.toElement(self)
  
@@ -246 +288 @@
      Generic XMPP subprotocol handler for incoming message stanzas.
 +
-+    @cvar stanzaFactory: The class to parse messages into. Its C{fromElement}
++    @cvar messageFactory: The class to parse messages into. Its C{fromElement}
 +        will be called with the received L{domish.Element}. Defaults to
 +        L{Message}.
@@ -252 +294 @@
  
 -    messageTypes = None, 'normal', 'chat', 'headline', 'groupchat'
-+    stanzaFactory = Message
++    messageFactory = Message
  
      def connectionInitialized(self):
@@ -264 +306 @@
 +    @asyncObserver
 +    def _onMessage(self, element):
-+        stanza = self.stanzaFactory.fromElement(element)
-+        return self.messageReceived(stanza)
++        if element.getAttribute(u'type') == u'error':
++            stanza = ErrorStanza.fromElement(element)
++            return self.errorReceived(stanza)
++        else:
++            stanza = self.messageFactory.fromElement(element)
++            return self.messageReceived(stanza)
  
 -        if messageType == 'error':
@@ -272 +318 @@
 -        if messageType not in self.messageTypes:
 -            message["type"] = 'normal'
--
++    def errorReceived(self, stanza):
++        """
++        Called when a message stanza of type error was received.
+ 
 -        self.onMessage(message)
--
++        @type stanza: L{ErrorStanza}
++        """
++        if hasattr(self, 'onMessage'):
++            warnings.warn(
++                "wokkel.xmppim.MessageProtocol.onMessage "
++                "was deprecated in Wokkel 0.8.0; "
++                "please use MessageProtocol.messageReceived instead.",
++                DeprecationWarning)
++            return False
+ 
 -    def onMessage(self, message):
++
 +    def messageReceived(self, message):
          """
@@ -295 +354 @@
 +                DeprecationWarning)
 +
-+            if message.stanzaType == u'error':
-+                return False
-+
 +            if message.stanzaType == u'normal':
 +                # Override stanza type for backwards compatibility.