Changeset 134:250a1041a437

Timestamp:

Aug 3, 2011, 8:48:50 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Parents:

133:2ea562934152 (diff), 104:7de2ae0a6a88 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge in trunk changes.

Location:

wokkel

Files:

• disco.py (modified) (10 diffs, 1 prop)
• iwokkel.py (modified) (2 diffs)
• iwokkel.py (modified) (1 prop)

wokkel/disco.py

@@ -1 +1 @@
 # -*- test-case-name: wokkel.test.test_disco -*-
 #
-# Copyright (c) 2003-2009 Ralph Meijer
+# Copyright (c) Ralph Meijer.
 # See LICENSE for details.
 
@@ -15 +15 @@
 from twisted.words.xish import domish
 
-from wokkel import data_form
-from wokkel.compat import IQ
+from wokkel import data_form, generic
 from wokkel.iwokkel import IDisco
 from wokkel.subprotocols import IQHandlerMixin, XMPPHandler
@@ -120 +119 @@
     @type nodeIdentifier: C{unicode}
     @ivar features: Features as L{DiscoFeature}.
-    @type features: C{set)
+    @type features: C{set}
     @ivar identities: Identities as a mapping from (category, type) to name,
                       all C{unicode}.
@@ -347 +346 @@
 
 
-class _DiscoRequest(IQ):
-    """
-    Element representing an XMPP service discovery request.
-    """
-
-    def __init__(self, xs, namespace, nodeIdentifier=''):
-        """
-        Initialize the request.
-
-        @param xs: XML Stream the request should go out on.
-        @type xs: L{xmlstream.XmlStream}
-        @param namespace: Request namespace.
-        @type namespace: C{str}
-        @param nodeIdentifier: Node to request info from.
-        @type nodeIdentifier: C{unicode}
-        """
-        IQ.__init__(self, xs, "get")
-        query = self.addElement((namespace, 'query'))
-        if nodeIdentifier:
-            query['node'] = nodeIdentifier
+class _DiscoRequest(generic.Request):
+    """
+    A Service Discovery request.
+
+    @ivar verb: Type of request: C{'info'} or C{'items'}.
+    @type verb: C{str}
+    @ivar nodeIdentifier: Optional node to request info for.
+    @type nodeIdentifier: C{unicode}
+    """
+
+    verb = None
+    nodeIdentifier = ''
+
+    _requestVerbMap = {
+            NS_DISCO_INFO: 'info',
+            NS_DISCO_ITEMS: 'items',
+            }
+
+    _verbRequestMap = dict(((v, k) for k, v in _requestVerbMap.iteritems()))
+
+    def __init__(self, verb=None, nodeIdentifier='',
+                       recipient=None, sender=None):
+        generic.Request.__init__(self, recipient=recipient, sender=sender,
+                                       stanzaType='get')
+        self.verb = verb
+        self.nodeIdentifier = nodeIdentifier
+
+
+    def parseElement(self, element):
+        generic.Request.parseElement(self, element)
+
+        verbElement = None
+        for child in element.elements():
+            if child.name == 'query' and child.uri in self._requestVerbMap:
+                self.verb = self._requestVerbMap[child.uri]
+                verbElement = child
+
+        if verbElement:
+            self.nodeIdentifier = verbElement.getAttribute('node', '')
+
+
+    def toElement(self):
+        element = generic.Request.toElement(self)
+
+        childURI = self._verbRequestMap[self.verb]
+        query = element.addElement((childURI, 'query'))
+
+        if self.nodeIdentifier:
+            query['node'] = self.nodeIdentifier
+
+        return element
 
 
@@ -389 +419 @@
         """
 
-        request = _DiscoRequest(self.xmlstream, NS_DISCO_INFO, nodeIdentifier)
-        if sender is not None:
-            request['from'] = unicode(sender)
-
-        d = request.send(entity.full())
+        request = _DiscoRequest('info', nodeIdentifier)
+        request.sender = sender
+        request.recipient = entity
+
+        d = self.request(request)
         d.addCallback(lambda iq: DiscoInfo.fromElement(iq.query))
         return d
@@ -412 +442 @@
         """
 
-        request = _DiscoRequest(self.xmlstream, NS_DISCO_ITEMS, nodeIdentifier)
-        if sender is not None:
-            request['from'] = unicode(sender)
-
-        d = request.send(entity.full())
+        request = _DiscoRequest('items', nodeIdentifier)
+        request.sender = sender
+        request.recipient = entity
+
+        d = self.request(request)
         d.addCallback(lambda iq: DiscoItems.fromElement(iq.query))
         return d
@@ -446 +476 @@
         @type iq: L{Element<twisted.words.xish.domish.Element>}
         """
-        requestor = jid.internJID(iq["from"])
-        target = jid.internJID(iq["to"])
-        nodeIdentifier = iq.query.getAttribute("node", '')
+        request = _DiscoRequest.fromElement(iq)
 
         def toResponse(info):
-            if nodeIdentifier and not info:
+            if request.nodeIdentifier and not info:
                 raise error.StanzaError('item-not-found')
             else:
                 response = DiscoInfo()
-                response.nodeIdentifier = nodeIdentifier
+                response.nodeIdentifier = request.nodeIdentifier
 
                 for item in info:
@@ -462 +490 @@
             return response.toElement()
 
-        d = self.info(requestor, target, nodeIdentifier)
+        d = self.info(request.sender, request.recipient,
+                      request.nodeIdentifier)
         d.addCallback(toResponse)
         return d
@@ -474 +503 @@
         @type iq: L{Element<twisted.words.xish.domish.Element>}
         """
-        requestor = jid.internJID(iq["from"])
-        target = jid.internJID(iq["to"])
-        nodeIdentifier = iq.query.getAttribute("node", '')
+        request = _DiscoRequest.fromElement(iq)
 
         def toResponse(items):
             response = DiscoItems()
-            response.nodeIdentifier = nodeIdentifier
+            response.nodeIdentifier = request.nodeIdentifier
 
             for item in items:
@@ -487 +514 @@
             return response.toElement()
 
-        d = self.items(requestor, target, nodeIdentifier)
+        d = self.items(request.sender, request.recipient,
+                       request.nodeIdentifier)
         d.addCallback(toResponse)
         return d

wokkel/iwokkel.py

@@ -1 @@
-# Copyright (c) Ralph Meijer.
+# Copyright (c) 2003-2008 Ralph Meijer
 # See LICENSE for details.
 
@@ -770 +770 @@
 
 
-    def affiliationsGet(request):
-        """
-        Called when a affiliations retrieval request (owner) has been received.
-
-        @param request: The publish-subscribe request.
-        @type request: L{wokkel.pubsub.PubSubRequest}
-        @return: A deferred that fires with a C{dict} of affiliations with the
-            entity as key (L{JID}) and the affiliation state as value
-            (C{unicode}).  The affiliation can be C{u'owner'}, C{u'publisher'},
-            or C{u'outcast'}.
-        @rtype: L{defer.Deferred}
-
-        @note: Affiliations are always on the bare JID. An implementation of
-        this method MUST NOT return JIDs with a resource part.
-        """
-
-
-    def affiliationsSet(request):
-        """
-        Called when a affiliations modify request has been received.
-
-        @param request: The publish-subscribe request.
-        @type request: L{wokkel.pubsub.PubSubRequest}
-        @return: A deferred that fires with C{None} when the affiliation
-            changes were succesfully processed..
-        @rtype: L{defer.Deferred}
-
-        @note: Affiliations are always on the bare JID. The JIDs in
-        L{wokkel.pubsub.PubSubRequest.affiliations} are already stripped of
-        any resource.
-        """
+
+class IMUCClient(Interface):
+    """
+    Multi-User Chat Client
+
+    A client interface to XEP-045 : http://xmpp.org/extensions/xep-0045.html
+
+    """
+
+    def receivedSubject(room, subject):
+        """
+        A subject is received when you join a room and when the subject is changed. This
+        method is triggered by one of those two events.
+
+        @param room: The room the subject was accepted for.
+        @type room: L{muc.Room}
+
+        @param subject: The subject of the given room.
+        @type subject: C{unicode}
+        """
+
+
+    def receivedHistory(room, user, message, history, frm=None):
+        """
+        Past messages from a chat room has been received. This occurs when you join a room.
+
+
+        """
+
+
+    def configure(room_jid, fields=[]):
+        """Configure a room. When a user has administration privledges they can configure 
+        a room. 
+
+        @param room_jid: A XMPP entity for the room.
+        @type room_jid: L{jid.JID}
+
+        @param fields: A list of fields to change or add to the room's configuration.
+        @type fields: C{list}
+
+        """
+
+    def getConfigureForm(room_jid):
+        """
+        In order to know the fields to change in a room you will need to get the form.
+        
+        @param room_jid: The room you want the configuration form from.
+        @type room_jid: L{jid.JID}
+
+        """
+
+    def join(server, room, nick):
+        """
+        Join a multi-user chat room. 
+
+        @param server: The server the room is on.
+        @type server: C{str}
+
+        @param room: The room name.
+        @type room: C{str}
+        
+        @param nick: The nick name you want when you join the room.
+        @type nick: C{str}
+
+        """
+
+
+    def leave(room_jid):
+        """
+        Leave a multi-user chat room.
+
+        @param room_jid: The room you want the configuration form from.
+        @type room_jid: L{jid.JID}
+
+        """
+
+    def userJoinedRoom(room, user):
+        """User has joined the room.
+
+        @param room: The room the user joined.
+        @type  room: L{muc.Room}
+
+        @param user: The user that joined the room.
+        @type  user: L{muc.User}
+
+        """
+   
+
+    def groupChat(to, message, children=None):
+        """Send a groupchat message to a room.
+
+        """
+
+
+    def chat(to, message, children=None):
+        """
+
+        """
+
+
+    def password(to, password):
+        """
+        """
+    
+    def register(to, fields=[]):
+        """
+        """
+
+
+    def subject(to, subject):
+        """
+        """
+
+    def voice(to):
+        """
+        """
+
+
+    def history(to, message_list):
+        """
+        """
+
+    def ban(to, ban_jid, frm, reason=None):
+        """
+        """
+
+
+    def kick(to, kick_jid, frm, reason=None):
+        """
+        """