Changeset 121:e74ad91e5c6f

Timestamp:

Oct 20, 2008, 10:28:22 PM (14 years ago)

Author:

Christopher Zorn <tofu@…>

Branch:

wokkel-muc-client-support-24

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/branches/wokkel-muc-client-support-24@117

Message:

add some more exeptions and implement history options

File:

• wokkel/muc.py (modified) (11 diffs)

wokkel/muc.py

@@ -117 +117 @@
     mucCondition = 'forbidden'
 
+class Conflict(Exception):
+    """
+    """
+    condition    = 'cancel'
+    mucCondition = 'conflict'
+
+class NotFound(Exception):
+    """
+    """
+    condition    = 'cancel'
+    mucCondition = 'not-found'
+
+class ServiceUnavailable(Exception):
+    """
+    """
+    condition    = 'wait'
+    mucCondition = 'service-unavailable'
+
+
 
 MUC_EXCEPTIONS = {
@@ -123 +142 @@
     'not-authorized': NotAuthorized,
     'exception': Exception,
+    'conflict': Conflict,
+    'service-unavailable': ServiceUnavailable,
+    'not-found': NotFound,
     }
 
@@ -316 +338 @@
             d['from'] = h_frm
 
+class HistoryOptions(object):
+    """A history configuration object.
+
+    @ivar maxchars: Limit the total number of characters in the history to "X" 
+                    (where the character count is the characters of the complete XML stanzas, not only their XML character data).
+    @itype maxchars: L{int}
+                
+    @ivar  maxstanzas:  Limit the total number of messages in the history to "X".
+    @itype mazstanzas: L{int}
+
+    @ivar  seconds: Send only the messages received in the last "X" seconds.
+    @itype seconds: L{int}
+
+    @ivar  since: Send only the messages received since the datetime specified (which MUST conform to the DateTime profile specified in XMPP Date and Time Profiles [14]).
+    @itype since: L{datetime.datetime}
+
+    """
+    attributes = ['maxchars', 'maxstanzas', 'seconds', 'since']
+
+    def __init__(self, maxchars=None, maxstanzas=None, seconds=None, since=None):
+        self.maxchars   = maxchars
+        self.maxstanzas = maxstanzas
+        self.seconds    = seconds
+        self.since      = since
+
+    def toElement(self):
+        h = domish.Element((None, 'history'))
+        for key in self.attributes:
+            a = getattr(self, key, a)
+            if a is not None:
+                h[key] = str(a)
+        
+        return h
+
 class User(object):
     """
@@ -516 +572 @@
         self._userLeavesRoom(room_jid)
         
-    def _getExceptionFromPresence(self, prs):
+    def _getExceptionFromElement(self, stanza):
         muc_condition = 'exception'
 
-        error = getattr(prs, 'error', None)
+        error = getattr(stanza, 'error', None)
         if error is not None:
             for e in error.elements():
@@ -629 +685 @@
         # check for errors
         if prs.hasAttribute('type') and prs['type'] == 'error':            
-            d.errback(self._getExceptionFromPresence(prs))
+            d.errback(self._getExceptionFromElement(prs))
         else:    
             # change the state of the room
             r = self._getRoom(room_jid)
             if r is None:
-                raise Exception, 'Room Not Found' 
+                raise NotFound
             r.state = 'joined'
             
@@ -652 +708 @@
         # check for errors
         if prs.hasAttribute('type') and prs['type'] == 'error':            
-            d.errback(prs)
+            d.errback(self._getExceptionFromElement(prs))
         else:    
             # change the state of the room
             r = self._getRoom(room_jid)
             if r is None:
-                raise Exception, 'Room Not Found' 
+                raise NotFound
             self._removeRoom(room_jid)
             
@@ -764 +820 @@
 
 
-    def join(self, server, room, nick):
+    def join(self, server, room, nick, history = None):
         """ Join a MUC room by sending presence to it. Returns a defered that is called when
         the entity is in the room or an error has occurred. 
@@ -777 +833 @@
         @type  nick: L{unicode}
         
+        @param history: The maximum number of history stanzas you would like.
+
         """
         r = Room(room, server, nick, state='joining')
@@ -782 +840 @@
  
         p = BasicPresence(to=r.entity_id)
+        if history is not None:
+            p.x.addChild(history.toElement())
+
         d = self.sendDeferred(p, timeout=DEFER_TIMEOUT)
 
@@ -815 +876 @@
         r = self._getRoom(room_jid)
         if r is None:
-            raise Exception, 'Room not found'
+            raise NotFound
         r.nick = new_nick # change the nick
         # create presence 
@@ -862 +923 @@
         r = self._getRoom(room_jid)
         if r is None:
-            raise Exception, 'Room not found'
+            raise NotFound
 
         p = BasicPresence(to=r.entityId())